FlashBlade REST API (2.19)
Download OpenAPI specification:Download
A lightweight client for FlashBlade REST API 2.19, developed by Pure Storage, Inc. (http://www.purestorage.com/).
Pure Storage uses the OAuth 2.0 Token Exchange authorization grant and JSON Web Tokens (JWTs) to authenticate to the Pure Storage REST API. Before you can exchange the ID token for an access token, create and enable the API client to generate the key_id, id, and issuer values. These values will be used as JWT claims for the subject_token parameter.
Get access token
Exchanges an ID Token for an OAuth 2.0 access token.
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/x-www-form-urlencoded
| grant_type required | string (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 |
Responses
Response samples
- 200
- 400
- 401
{- "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"
}Active Directory configuration joins a server to the domain and manages its computer account. Authentication for NFS or SMB is performed using Kerberos. This configuration is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries.
GET active-directory
List Active Directory accounts and their configuration.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "computer_name": "FLASHBLADE01",
- "directory_servers": [
- "ldap.my-corporation.com"
], - "domain": "my-corporation.com",
- "encryption_types": [
- "aes256-cts-hmac-sha1-96"
], - "global_catalog_servers": [
- "gc.my-corporation.com"
], - "join_ou": "CN=Computers",
- "kerberos_servers": [
- "krb-host.my-corporation.com"
], - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "service_principal_names": [
- "nfs/vip1.my-array.my-corporation.com"
]
}
]
}POST active-directory
Join an Active Directory domain and generate keytabs for the registered SPNs and supported encryption types.
Authorizations:
query Parameters
| join_existing_account | boolean If specified as |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| directory_servers | Array of strings <= 50 items A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array's configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50. |
| global_catalog_servers | Array of strings <= 50 items A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array's configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50. |
| computer_name | string The common 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. |
| domain required | string The Active Directory domain to join. |
| encryption_types | Array of strings The encryption types that will be supported for use by clients for Kerberos
authentication.
Defaults to |
| fqdns | Array of strings <= 32 items A list of fully qualified domain names to use to register service principal
names for the machine account. If specified, every service principal that
is supported by the array will be registered for each fully qualified domain
name specified. If neither |
| join_ou | string The relative distinguished name of the organizational unit in which the
computer account should be created when joining the domain.
Cannot be provided if using an existing machine account.
If not specified, defaults to |
| kerberos_servers | Array of strings <= 5 items A list of key distribution servers to use for Kerberos protocol. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array's configured DNS. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5. |
| password required | string The login password of the user with privileges to create the computer account in the domain. If using an existing computer account, the user must have privileges to read attributes from the computer account and reset the password on that account. This is not persisted on the array. |
| service_principal_names | Array of strings <= 32 items A list of service principal names to register for the machine account,
which can be used for the creation of keys for Kerberos authentication.
If neither |
| user required | string The login name of the user with privileges to create the computer account in the domain. If using an existing computer account, the user must have privileges to read attributes from the computer account and reset the password on that account. This is not persisted on the array. |
Responses
Request samples
- Payload
{- "directory_servers": [
- "ldap.my-corporation.com"
], - "global_catalog_servers": [
- "gc.my-corporation.com"
], - "computer_name": "FLASHBLADE01",
- "domain": "my-corporation.com",
- "encryption_types": [
- "aes256-cts-hmac-sha1-96"
], - "fqdns": [
- "vip1.my-array.my-corporation.com"
], - "join_ou": "CN=Computers",
- "kerberos_servers": [
- "kdc.my-corporation.com"
], - "password": "Anything#but$adMinistrat0r",
- "service_principal_names": [
- "nfs/vip1.my-array.my-corporation.com"
], - "user": "Administrator"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "computer_name": "FLASHBLADE01",
- "directory_servers": [
- "ldap.my-corporation.com"
], - "domain": "my-corporation.com",
- "encryption_types": [
- "aes256-cts-hmac-sha1-96"
], - "global_catalog_servers": [
- "gc.my-corporation.com"
], - "join_ou": "CN=Computers",
- "kerberos_servers": [
- "krb-host.my-corporation.com"
], - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "service_principal_names": [
- "nfs/vip1.my-array.my-corporation.com"
]
}
]
}DELETE active-directory
Delete an Active Directory account.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| local_only | boolean If specified as |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH active-directory
Modify the configuration of an Active Directory account.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| directory_servers | Array of strings <= 50 items A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array's configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50. |
| global_catalog_servers | Array of strings <= 50 items A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array's configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50. |
| encryption_types | Array of strings The encryption types that will be supported for use by clients for Kerberos
authentication.
Valid values include |
| fqdns | Array of strings <= 32 items A list of fully qualified domain names to use to register service principal
names for the machine account. If specified, every service principal that
is supported by the array will be registered for each fully qualified domain
name specified. If neither |
| join_ou | string The relative distinguished name of the organizational unit in which the computer account should be created when joining the domain. |
| kerberos_servers | Array of strings <= 5 items A list of key distribution servers to use for Kerberos protocol. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array's configured DNS. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5. |
| service_principal_names | Array of strings <= 32 items A list of service principal names to register for the machine account,
which can be used for the creation of keys for Kerberos authentication.
If neither |
Responses
Request samples
- Payload
{- "directory_servers": [
- "ldap.my-corporation.com"
], - "global_catalog_servers": [
- "gc.my-corporation.com"
], - "encryption_types": [
- "aes256-cts-hmac-sha1-96"
], - "fqdns": [
- "vip1.my-array.my-corporation.com"
], - "join_ou": "OU=Purestorage,OU=StorageMachines",
- "kerberos_servers": [
- "kdc.my-corporation.com"
], - "service_principal_names": [
- "nfs/vip1.my-array.my-corporation.com"
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "computer_name": "FLASHBLADE01",
- "directory_servers": [
- "ldap.my-corporation.com"
], - "domain": "my-corporation.com",
- "encryption_types": [
- "aes256-cts-hmac-sha1-96"
], - "global_catalog_servers": [
- "gc.my-corporation.com"
], - "join_ou": "CN=Computers",
- "kerberos_servers": [
- "krb-host.my-corporation.com"
], - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "service_principal_names": [
- "nfs/vip1.my-array.my-corporation.com"
]
}
]
}GET active-directory/test
Testing if the configuration of an Active Directory account is valid.
Authorizations:
query Parameters
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
], - "total_item_count": 0
}Manage administrators, including their REST API Token and public key for SSH access. The array has a single default administrative account named pureuser. Additional administrators and their administrative roles can be added by configuring the management directory service for the array or by creating local administrative users. The available administrative roles are array_admin, storage_admin,readonly, ops_admin.
GET admins
List the administrator's attributes, including the API token and public key.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| expose_api_token | boolean If |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "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"
}
], - "public_key": "string",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST admins
Create a new local administrator.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (_referenceWritable) List of management access policies associated with the administrator. | |
| password | string New user password. |
| public_key | string Public key for SSH access. Supported key types include |
object (ReferenceWritable) Deprecated.
|
Responses
Request samples
- Payload
{- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "password": "string",
- "public_key": "string",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "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"
}
], - "public_key": "string",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE admins
Delete a local administrator..
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH admins
Modify the attributes of an administrator.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| locked | boolean If set to |
| old_password | string Old user password. |
| password | string New user password. |
| public_key | string Public key for SSH access. Supported key types are |
object (ReferenceWritable) Deprecated.
|
Responses
Request samples
- Payload
{- "locked": false,
- "old_password": "string",
- "password": "string",
- "public_key": "string",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "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"
}
], - "public_key": "string",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}GET admins/api-tokens
Displays API tokens for the specified administrators.
Authorizations:
query Parameters
| admin_ids | Array of strings A comma-separated list of admin IDs. If after filtering, there is not
at least one admin resource that matches each of the elements, then an error
is returned. This cannot be provided together with the |
| admin_names | Array of strings A comma-separated list of admin names. If there is not at least one
admin resource that matches each of the elements, then an error is returned.
This cannot be provided together with |
| 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 |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "admin": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "api_token": {
- "created_at": 0,
- "expires_at": 0,
- "token": "string"
}
}
]
}POST admins/api-tokens
Creates API tokens for the specified administrators.
Authorizations:
query Parameters
| admin_ids | Array of strings A comma-separated list of admin IDs. If after filtering, there is not
at least one admin resource that matches each of the elements, then an error
is returned. This cannot be provided together with the |
| admin_names | Array of strings A comma-separated list of admin names. If there is not at least one
admin resource that matches each of the elements, then an error is returned.
This cannot be provided together with |
| timeout | integer <int64> The duration of API token validity, in milliseconds. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "admin": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "api_token": {
- "created_at": 0,
- "expires_at": 0,
- "token": "string"
}
}
]
}DELETE admins/api-tokens
Deletes the API tokens of the specified administrators.
Authorizations:
query Parameters
| admin_ids | Array of strings A comma-separated list of admin IDs. If after filtering, there is not
at least one admin resource that matches each of the elements, then an error
is returned. This cannot be provided together with the |
| admin_names | Array of strings A comma-separated list of admin names. If there is not at least one
admin resource that matches each of the elements, then an error is returned.
This cannot be provided together with |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET admins/cache
List cached administrator information used to determine role based access control privileges.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| refresh | boolean Whether to refresh the user info from directory service.
If not specified, defaults to |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time": 0
}
]
}DELETE admins/cache
Delete cached administrator role information by name or ID.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
List global admin settings
Return global admin settings.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "lockout_duration": 3600000,
- "max_login_attempts": 10,
- "min_password_length": 1
}
]
}Update global admin settings
Update properties for global admin settings.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| lockout_duration | integer <int64> [ 0 .. 7776000000 ] The lockout duration, in milliseconds, if a user has reached the
maximum number of login attempts. Ranges from 1 second to 90 days.
Default value is |
| max_login_attempts | integer <int32> [ 0 .. 100 ] The maximum number of failed login attempts allowed before the user is locked out.
Default value is |
| min_password_length | integer <int32> [ 1 .. 100 ] The minimum password length. If not specified, defaults to 1 character. |
Responses
Request samples
- Payload
{- "lockout_duration": 3600000,
- "max_login_attempts": 10,
- "min_password_length": 1
}Response samples
- 200
{- "items": [
- {
- "lockout_duration": 3600000,
- "max_login_attempts": 10,
- "min_password_length": 1
}
]
}Alerts indicate significant events that occur on the array, including whenever a component degrades or the capacity threshold of the component is reached.
GET alerts
Returns a list of alerts which have been generated by the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "action": "string",
- "code": 0,
- "component_name": "string",
- "component_type": "string",
- "created": 0,
- "description": "string",
- "flagged": true,
- "index": 0,
- "knowledge_base_url": "string",
- "notified": 0,
- "severity": "string",
- "state": "string",
- "summary": "string",
- "updated": 0,
- "variables": {
- "property1": "string",
- "property2": "string"
}
}
]
}PATCH alerts
Make changes to an alert. This is currently limited to the alert's flagged property.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| flagged | boolean Flagged state of the alert. |
Responses
Request samples
- Payload
{- "flagged": true
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "action": "string",
- "code": 0,
- "component_name": "string",
- "component_type": "string",
- "created": 0,
- "description": "string",
- "flagged": true,
- "index": 0,
- "knowledge_base_url": "string",
- "notified": 0,
- "severity": "string",
- "state": "string",
- "summary": "string",
- "updated": 0,
- "variables": {
- "property1": "string",
- "property2": "string"
}
}
]
}GET alert-watchers
List alert watchers that are configured to receive alert messages.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "minimum_notification_severity": "string"
}
]
}POST alert-watchers
Create an alert watcher to receive array alert messages.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| minimum_notification_severity | string The minimum severity that an alert must have in order for emails to
be sent to the watcher.
Possible values include |
Responses
Request samples
- Payload
{- "minimum_notification_severity": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "minimum_notification_severity": "string"
}
]
}DELETE alert-watchers
Delete an alert watcher.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH alert-watchers
Modify an alert watcher’s configuration. Enable or disable an alert watcher privilege and select the level of alert notification of an alert watcher. Alert notification levels are info, warning, or critical.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| enabled | boolean Is email notification enabled? If not specified, defaults to |
| minimum_notification_severity | string The minimum severity that an alert must have in order for emails to
be sent to the watcher.
Possible values include |
Responses
Request samples
- Payload
{- "enabled": true,
- "minimum_notification_severity": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "minimum_notification_severity": "string"
}
]
}GET alert-watchers/test
Test an alert watcher's contact information to verify alerts can be sent and received.
Authorizations:
query Parameters
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
]
}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.
GET api-clients
List an API client and its configuration attributes.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "access_token_ttl_in_ms": 15000,
- "enabled": true,
- "key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "max_role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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"
}
]
}POST api-clients
Create an API client to authorize Access Token or Bearer Tokens for use on the array. Required fields include issuer, public_key, and access_token_ttl_in_ms. After creating an API client, it can only be enabled by an authorized user.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (_referenceWritable) 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) duration for which the exchanged access token is valid.
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 |
object (ReferenceWritable) 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 required | string The API client's PEM formatted (Base64 encoded) RSA public key.
It must include the |
Responses
Request samples
- Payload
{- "access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "access_token_ttl_in_ms": 15000,
- "max_role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "access_token_ttl_in_ms": 15000,
- "enabled": true,
- "key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "max_role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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"
}
]
}DELETE api-clients
Delete the API client.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH api-clients
Modify an API client. Newly created API clients can be enabled by setting the enabled parameter to true.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| enabled | boolean If |
object (FixedReference) 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 |
Responses
Request samples
- Payload
{- "enabled": true,
- "max_role": { }
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "access_token_ttl_in_ms": 15000,
- "enabled": true,
- "key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "max_role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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"
}
]
}Arrays features provide the ability to configure settings that affect the array as a whole, monitor array I/O performance, and make sure that the array is operating properly.
GET arrays
List array attributes such as the array name, ID, version, and NTP servers.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "_as_of": 0,
- "banner": "Restricted area. Authorized personnel only.",
- "default_inbound_tls_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "encryption": {
- "data_at_rest": {
- "algorithms": [
- "AES-256-GCM"
], - "enabled": true,
- "entropy_source": "rdseed"
}
}, - "eradication_config": {
- "eradication_delay": 86400000,
- "manual_eradication": "string"
}, - "idle_timeout": 300000,
- "network_access_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ntp_servers": [
- "time.acme.com"
], - "os": "Purity//FB",
- "product_type": "string",
- "revision": "2017.11.07_8f3ab6f5",
- "security_update": "fb-2022-04-04",
- "smb_mode": "string",
- "time_zone": "America/Los_Angeles",
- "version": "2.1.0"
}
]
}PATCH arrays
Modify the general configuration of the array including banner text, array name, NTP servers, and time zone.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| banner | string A string to be shown when logging in to the array. |
object (ReferenceWritable) The default TLS policy governing inbound traffic from clients accessing the array. This TLS policy will be applied for any IP addresses on the system that do not have a specific policy applied to them at a more granular level. | |
object (ArrayEradicationConfig) | |
| idle_timeout | integer <int32> Idle timeout in milliseconds. Valid values are in the range of 300000 and 10800000. Setting this value to 0 disables timeouts. |
object (FixedReference) The network access policy governing which clients are allowed or denied access to different array interfaces. | |
| ntp_servers | Array of strings |
| time_zone | string The time zone to use for the array. In particular this affects the CLI formatting and the default snapshot policy time zone. |
Responses
Request samples
- Payload
{- "name": "string",
- "banner": "Restricted area. Authorized personnel only.",
- "default_inbound_tls_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "eradication_config": { },
- "idle_timeout": 300000,
- "network_access_policy": { },
- "ntp_servers": [
- "time.acme.com"
], - "time_zone": "America/Los_Angeles"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "_as_of": 0,
- "banner": "Restricted area. Authorized personnel only.",
- "default_inbound_tls_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "encryption": {
- "data_at_rest": {
- "algorithms": [
- "AES-256-GCM"
], - "enabled": true,
- "entropy_source": "rdseed"
}
}, - "eradication_config": {
- "eradication_delay": 86400000,
- "manual_eradication": "string"
}, - "idle_timeout": 300000,
- "network_access_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ntp_servers": [
- "time.acme.com"
], - "os": "Purity//FB",
- "product_type": "string",
- "revision": "2017.11.07_8f3ab6f5",
- "security_update": "fb-2022-04-04",
- "smb_mode": "string",
- "time_zone": "America/Los_Angeles",
- "version": "2.1.0"
}
]
}GET arrays/eula
List the End User Agreement and signature.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "agreement": "string",
- "signature": {
- "accepted": 1577880000000,
- "company": "Example Inc.",
- "name": "John Doe",
- "title": "Admin"
}
}
]
}PATCH arrays/eula
Modifies the signature on the End User Agreement.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (_eula_signature) |
Responses
Request samples
- Payload
{- "signature": {
- "company": "Example Inc.",
- "name": "John Doe",
- "title": "Admin"
}
}Response samples
- 200
{- "items": [
- {
- "agreement": "string",
- "signature": {
- "accepted": 1577880000000,
- "company": "Example Inc.",
- "name": "John Doe",
- "title": "Admin"
}
}
]
}List factory reset tokens
Displays a list of tokens used to perform a factory reset on the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "token": 5671919
}
]
}Create a factory reset token
Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all file systems, buckets, and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state (e.g., creating file systems) are disabled until all tokens have been deleted.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "name": "string",
- "token": 5671919
}
]
}GET arrays/http-specific-performance
List the HTTP performance metrics of the array.
Authorizations:
query Parameters
| 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, |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "others_per_sec": 0,
- "read_dirs_per_sec": 0,
- "read_files_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_dir_op": 0,
- "usec_per_read_file_op": 0,
- "usec_per_write_dir_op": 0,
- "usec_per_write_file_op": 0,
- "write_dirs_per_sec": 0,
- "write_files_per_sec": 0
}
]
}GET arrays/nfs-specific-performance
List the NFS performance metrics of the array.
Authorizations:
query Parameters
| 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, |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "accesses_per_sec": 0,
- "aggregate_file_metadata_creates_per_sec": 0,
- "aggregate_file_metadata_modifies_per_sec": 0,
- "aggregate_file_metadata_reads_per_sec": 0,
- "aggregate_other_per_sec": 0,
- "aggregate_share_metadata_reads_per_sec": 0,
- "aggregate_usec_per_file_metadata_create_op": 0,
- "aggregate_usec_per_file_metadata_modify_op": 0,
- "aggregate_usec_per_file_metadata_read_op": 0,
- "aggregate_usec_per_other_op": 0,
- "aggregate_usec_per_share_metadata_read_op": 0,
- "creates_per_sec": 0,
- "fsinfos_per_sec": 0,
- "fsstats_per_sec": 0,
- "getattrs_per_sec": 0,
- "links_per_sec": 0,
- "lookups_per_sec": 0,
- "mkdirs_per_sec": 0,
- "pathconfs_per_sec": 0,
- "readdirpluses_per_sec": 0,
- "readdirs_per_sec": 0,
- "readlinks_per_sec": 0,
- "reads_per_sec": 0,
- "removes_per_sec": 0,
- "renames_per_sec": 0,
- "rmdirs_per_sec": 0,
- "setattrs_per_sec": 0,
- "symlinks_per_sec": 0,
- "time": 0,
- "usec_per_access_op": 0,
- "usec_per_create_op": 0,
- "usec_per_fsinfo_op": 0,
- "usec_per_fsstat_op": 0,
- "usec_per_getattr_op": 0,
- "usec_per_link_op": 0,
- "usec_per_lookup_op": 0,
- "usec_per_mkdir_op": 0,
- "usec_per_pathconf_op": 0,
- "usec_per_read_op": 0,
- "usec_per_readdir_op": 0,
- "usec_per_readdirplus_op": 0,
- "usec_per_readlink_op": 0,
- "usec_per_remove_op": 0,
- "usec_per_rename_op": 0,
- "usec_per_rmdir_op": 0,
- "usec_per_setattr_op": 0,
- "usec_per_symlink_op": 0,
- "usec_per_write_op": 0,
- "writes_per_sec": 0
}
]
}GET arrays/performance
Lists the overall performance metrics of the array.
Authorizations:
query Parameters
| 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, |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| protocol | string Display the performance of a specified protocol.
Valid values are |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource 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
}
]
}GET arrays/performance/replication
List replication performance metrics.
Authorizations:
query Parameters
| 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, |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| type | string Display the metric of a specified object type.
Valid values are |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "aggregate": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "continuous": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0,
- "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}
}, - "periodic": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "time": 0
}
]
}GET arrays/s3-specific-performance
List the S3 performance metrics of the array.
Authorizations:
query Parameters
| 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, |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "others_per_sec": 0,
- "read_buckets_per_sec": 0,
- "read_objects_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_bucket_op": 0,
- "usec_per_read_object_op": 0,
- "usec_per_write_bucket_op": 0,
- "usec_per_write_object_op": 0,
- "write_buckets_per_sec": 0,
- "write_objects_per_sec": 0
}
]
}GET arrays/space
List available and used storage space on the array.
Authorizations:
query Parameters
| 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, |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| type | string Display the metric of a specified object type.
Valid values are |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "capacity": 10995116277760,
- "parity": 0.99,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time": 0
}
]
}GET arrays/space/storage-classes
List available and used storage space for storage classes on the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| 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 offset of the first resource to return from a collection. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| storage_class_names | Array of strings A comma-separated list of storage class names. Valid values include |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "capacity": 10995116277760,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time": 0
}
], - "total": {
- "name": "string",
- "capacity": 10995116277760,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time": 0
}
}GET arrays/supported-time-zones
List supported time zones for the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string"
}
]
}Create a process for factory reset
Creates the initiation of the factory reset process.
Authorizations:
query Parameters
| eradicate_all_data required | boolean Default: true Set to |
| preserve_configuration_data required | string Default: "none" For the initial phase |
| skip_phonehome_check required | boolean Default: false A flag to skip phonehome connectivity check.
Arrays that intentionally disable phonehome or do not permit connectivity
to Pure Storage's cloud servers must set this flag to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "name": "string",
- "details": "string",
- "sanitization_certificate": "NIST SP800-88R1 section 4.8 ...",
- "status": "resetting"
}
]
}Factory reset - finalize
After the process has been completed, we need to finalize the factory reset process.
Authorizations:
query Parameters
| delete_sanitization_certificate required | boolean Default: true Must be |
| eradicate_all_data required | boolean Default: true Set to |
| finalize required | boolean Default: true Must be |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "name": "string",
- "details": "string",
- "sanitization_certificate": "NIST SP800-88R1 section 4.8 ...",
- "status": "resetting"
}
]
}Get factory reset status
Get the factory reset process status.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "details": "string",
- "sanitization_certificate": "NIST SP800-88R1 section 4.8 ...",
- "status": "resetting"
}
]
}View and manage connected arrays, including their network configurations, connection keys, and replication performance.
GET array-connections
List connected arrays for replication.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 offset of the first resource to return from a collection. |
| 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 Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "encrypted": true,
- "management_address": "10.202.101.78",
- "os": "string",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "replication_addresses": [
- "10.202.101.70"
], - "status": "string",
- "throttle": {
- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152
}, - "type": "string",
- "version": "2.3.0"
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST array-connections
Create a connection to an array for replication and configure network settings.
Authorizations:
query Parameters
| 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (FixedReference) The group of CA certificates that can be used, in addition to
well-known Certificate Authority certificates, in order to
establish a secure connection to the target array.
Defaults to a reference to the | |
| encrypted | boolean If this is set to |
| management_address | string Management address of the target array. Settable on POST only. |
object (FixedReference) The remote array. | |
| replication_addresses | Array of strings IP addresses and/or FQDNs of the target arrays. Settable on POST only. If not set on POST, will be set to all the replication addresses available on the target array at the time of the POST. |
object The bandwidth throttling for an array connection or target. | |
| connection_key | string The connection key of the target array. Settable on POST only. |
Responses
Request samples
- Payload
{- "ca_certificate_group": { },
- "encrypted": true,
- "management_address": "10.202.101.78",
- "remote": { },
- "replication_addresses": [
- "10.202.101.70"
], - "throttle": {
- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152
}, - "connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "encrypted": true,
- "management_address": "10.202.101.78",
- "os": "string",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "replication_addresses": [
- "10.202.101.70"
], - "status": "string",
- "throttle": {
- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152
}, - "type": "string",
- "version": "2.3.0"
}
]
}DELETE array-connections
Delete a connection to an array.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| remote_ids | Array of strings A comma-separated list of remote array IDs. Deprecated, best practice is to reference connections
with |
| remote_names | Array of strings A comma-separated list of remote array names. Deprecated, best practice is to reference
connections with |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH array-connections
Modify the configuration of a connected array.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| remote_ids | Array of strings A comma-separated list of remote array IDs. Deprecated, best practice is to reference connections
with |
| remote_names | Array of strings A comma-separated list of remote array names. Deprecated, best practice is to reference
connections with |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (FixedReference) The group of CA certificates that can be used, in addition to
well-known Certificate Authority certificates, in order to
establish a secure connection to the target array.
Defaults to a reference to the | |
| encrypted | boolean If this is set to |
| management_address | string Management address of the target array. Settable on POST only. |
object (FixedReference) The remote array. | |
| replication_addresses | Array of strings IP addresses and/or FQDNs of the target arrays. Settable on POST only. If not set on POST, will be set to all the replication addresses available on the target array at the time of the POST. |
object (_throttle) The bandwidth throttling for an array connection or target. |
Responses
Request samples
- Payload
{- "ca_certificate_group": { },
- "encrypted": true,
- "management_address": "10.202.101.78",
- "remote": { },
- "replication_addresses": [
- "10.202.101.70"
], - "throttle": {
- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "encrypted": true,
- "management_address": "10.202.101.78",
- "os": "string",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "replication_addresses": [
- "10.202.101.70"
], - "status": "string",
- "throttle": {
- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152
}, - "type": "string",
- "version": "2.3.0"
}
]
}GET array-connections/connection-key
List connection keys used to authenticate the connection from one array to another.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "created": 0,
- "expires": 0
}
]
}POST array-connections/connection-key
Create an array connection key allowing one array to connect to another for replication.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "created": 0,
- "expires": 0
}
]
}GET array-connections/path
List network path details of connected arrays.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 offset of the first resource to return from a collection. |
| 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 Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destination": "10.202.101.70:443",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "source": "10.202.101.70",
- "status": "string",
- "status_details": "string",
- "type": "string"
}
]
}GET array-connections/performance/replication
List performance metrics of file systems or objects being replicated from one array to another.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 offset of the first resource to return from a collection. |
| 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 |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| total_only | boolean If set to |
| type | string Display the metric of a specified object type.
Valid values are |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "aggregate": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "continuous": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0,
- "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}
}, - "periodic": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "remote": {
- "id": "string",
- "name": "string"
}, - "time": 0
}
], - "total": [
- {
- "id": "string",
- "aggregate": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "continuous": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0,
- "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}
}, - "periodic": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "remote": {
- "id": "string",
- "name": "string"
}, - "time": 0
}
]
}View the audit trail on the array. Every request that creates, modifies, or deletes a resource will be logged in the audit trail.
GET audits
List the array audit trail to view activities that were performed on the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "arguments": "string",
- "command": "string",
- "ip_address": "string",
- "origin": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "subcommand": "string",
- "time": 0,
- "user": "string",
- "user_agent": "string",
- "user_interface": "CLI"
}
]
}GET blades
List array blade information.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "details": "string",
- "progress": 0,
- "raw_capacity": 0,
- "status": "string",
- "target": "string"
}
], - "total": {
- "id": "string",
- "name": "string",
- "details": "string",
- "progress": 0,
- "raw_capacity": 0,
- "status": "string",
- "target": "string"
}
}GET buckets
List object store bucket attributes such as creation time and space usage.
Authorizations:
query Parameters
| 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) are specified in the |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket_type": "string",
- "created": 0,
- "destroyed": true,
- "eradication_config": {
- "eradication_delay": 86400000,
- "eradication_mode": "permission-based",
- "manual_eradication": "enabled"
}, - "hard_limit_enabled": true,
- "object_count": 0,
- "object_lock_config": {
- "default_retention_mode": "governance",
- "enabled": true,
- "freeze_locked_objects": true,
- "default_retention": 86400000
}, - "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "public_status": "bucket-and-objects-not-public",
- "quota_limit": 0,
- "retention_lock": "unlocked",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": {
- "name": "string",
- "status": "string",
- "status_details": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "time_remaining": 0,
- "time_remaining_status": "calculating",
- "versioning": "string"
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "total": {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket_type": "string",
- "created": 0,
- "destroyed": true,
- "eradication_config": {
- "eradication_delay": 86400000,
- "eradication_mode": "permission-based",
- "manual_eradication": "enabled"
}, - "hard_limit_enabled": true,
- "object_count": 0,
- "object_lock_config": {
- "default_retention_mode": "governance",
- "enabled": true,
- "freeze_locked_objects": true,
- "default_retention": 86400000
}, - "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "public_status": "bucket-and-objects-not-public",
- "quota_limit": 0,
- "retention_lock": "unlocked",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": {
- "name": "string",
- "status": "string",
- "status_details": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "time_remaining": 0,
- "time_remaining_status": "calculating",
- "versioning": "string"
}
}POST buckets
Create a new object store bucket.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (ReferenceWritable) The account name for bucket creation. | |
| bucket_type | string The bucket type for the bucket. Valid values are |
object (_bucketEradicationConfig) Configuration settings related to bucket eradication. | |
| hard_limit_enabled | boolean If set to |
object (_objectLockConfigRequestBody) Configuration settings related to object lock. | |
| quota_limit | string The effective quota limit applied against the size of the bucket, displayed in bytes.
If set to an empty string ( |
| retention_lock | string If set to |
Responses
Request samples
- Payload
{- "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket_type": "string",
- "eradication_config": {
- "eradication_mode": "permission-based"
}, - "hard_limit_enabled": true,
- "object_lock_config": {
- "default_retention_mode": "governance",
- "enabled": true,
- "freeze_locked_objects": true,
- "default_retention": "86400000"
}, - "quota_limit": "string",
- "retention_lock": "unlocked"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket_type": "string",
- "created": 0,
- "destroyed": true,
- "eradication_config": {
- "eradication_delay": 86400000,
- "eradication_mode": "permission-based",
- "manual_eradication": "enabled"
}, - "hard_limit_enabled": true,
- "object_count": 0,
- "object_lock_config": {
- "default_retention_mode": "governance",
- "enabled": true,
- "freeze_locked_objects": true,
- "default_retention": 86400000
}, - "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "public_status": "bucket-and-objects-not-public",
- "quota_limit": 0,
- "retention_lock": "unlocked",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": {
- "name": "string",
- "status": "string",
- "status_details": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "time_remaining": 0,
- "time_remaining_status": "calculating",
- "versioning": "string"
}
]
}DELETE buckets
Delete object store buckets.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH buckets
Modify object store bucket attributes such as destroyed and versioning.
Authorizations:
query Parameters
| cancel_in_progress_storage_class_transition | 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 |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| ignore_usage | boolean Allow update operations that lead to a |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| destroyed | boolean Is the bucket destroyed? |
object (_bucketEradicationConfig) Configuration settings related to bucket eradication. | |
| hard_limit_enabled | boolean If set to |
object (_objectLockConfigRequestBody) Configuration settings related to object lock. | |
object (_publicAccessConfig) Configuration settings related to public access. | |
| quota_limit | string The effective quota limit applied against the size of the bucket, displayed in bytes.
If set to an empty string ( |
| retention_lock | string If set to |
object (StorageClassInfo) | |
| versioning | string The versioning state for objects within the bucket.
Valid values are |
Responses
Request samples
- Payload
{- "destroyed": true,
- "eradication_config": {
- "eradication_mode": "permission-based"
}, - "hard_limit_enabled": true,
- "object_lock_config": {
- "default_retention_mode": "governance",
- "enabled": true,
- "freeze_locked_objects": true,
- "default_retention": "86400000"
}, - "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "quota_limit": "string",
- "retention_lock": "unlocked",
- "storage_class": {
- "name": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string"
}
}, - "versioning": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket_type": "string",
- "created": 0,
- "destroyed": true,
- "eradication_config": {
- "eradication_delay": 86400000,
- "eradication_mode": "permission-based",
- "manual_eradication": "enabled"
}, - "hard_limit_enabled": true,
- "object_count": 0,
- "object_lock_config": {
- "default_retention_mode": "governance",
- "enabled": true,
- "freeze_locked_objects": true,
- "default_retention": 86400000
}, - "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "public_status": "bucket-and-objects-not-public",
- "quota_limit": 0,
- "retention_lock": "unlocked",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": {
- "name": "string",
- "status": "string",
- "status_details": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "time_remaining": 0,
- "time_remaining_status": "calculating",
- "versioning": "string"
}
]
}GET buckets/cross-origin-resource-sharing-policies
List cross origin resource sharing policy for the specified bucket and its attributes.
Either names or bucket_names/bucket_ids query parameters can be used.
Authorizations:
query Parameters
| allow_errors | boolean Default: false If set to |
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": [
- {
- "name": "string",
- "allowed_headers": [
- "*"
], - "allowed_methods": [
- "GET",
- "PUT",
- "HEAD",
- "POST",
- "DELETE"
], - "allowed_origins": [
- "*"
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}
]
}POST buckets/cross-origin-resource-sharing-policies
Create a new cross origin resource sharing policy for the specified bucket. Policy's name will be autogenerated by the system.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (CrossOriginResourceSharingPolicyRuleBulkManage) |
Responses
Request samples
- Payload
{- "rules": [
- {
- "allowed_headers": [
- "*"
], - "allowed_methods": [
- "GET",
- "PUT",
- "HEAD",
- "POST",
- "DELETE"
], - "allowed_origins": [
- "*"
], - "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": [
- {
- "name": "string",
- "allowed_headers": [
- "*"
], - "allowed_methods": [
- "GET",
- "PUT",
- "HEAD",
- "POST",
- "DELETE"
], - "allowed_origins": [
- "*"
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}
]
}DELETE buckets/cross-origin-resource-sharing-policies
Delete a cross origin resource sharing policy of the specified bucket.
Either names or bucket_names/bucket_ids query parameters can be used.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET buckets/cross-origin-resource-sharing-policies/rules
List cross origin resource sharing policy rules for the specified bucket and their attributes.
Either policy_names or bucket_names query parameters can be used.
Authorizations:
query Parameters
| allow_errors | boolean Default: false If set to |
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "name": "string",
- "allowed_headers": [
- "*"
], - "allowed_methods": [
- "GET",
- "PUT",
- "HEAD",
- "POST",
- "DELETE"
], - "allowed_origins": [
- "*"
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST buckets/cross-origin-resource-sharing-policies/rules
Create a new cross origin resource sharing policy rule for the specified bucket.
Either policy_names or bucket_names query parameters can be used.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names. |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| allowed_headers | Array of strings A list of headers that are permitted to be included in cross-origin requests to
access a bucket. The only currently supported allowed header is |
| allowed_methods | Array of strings A list of HTTP methods that are permitted for cross-origin requests to access a bucket.
The only currently supported combination of allowed methods is all methods
|
| allowed_origins | Array of strings A list of origins (domains) that are permitted to make cross-origin requests to
access a bucket. The only currently supported allowed origin is |
Responses
Request samples
- Payload
{- "allowed_headers": [
- "*"
], - "allowed_methods": [
- "GET",
- "PUT",
- "HEAD",
- "POST",
- "DELETE"
], - "allowed_origins": [
- "*"
]
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "allowed_headers": [
- "*"
], - "allowed_methods": [
- "GET",
- "PUT",
- "HEAD",
- "POST",
- "DELETE"
], - "allowed_origins": [
- "*"
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE buckets/cross-origin-resource-sharing-policies/rules
Delete one or more cross origin resource sharing policy rules for the specified bucket.
Either policy_names or bucket_names query parameters can be used.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET buckets/performance
List performance metrics for a bucket.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "max_total_bytes_per_sec": 0,
- "max_total_ops_per_sec": 0,
- "others_per_sec": 0,
- "read_bytes_per_sec": 0,
- "reads_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_op": 0,
- "usec_per_write_op": 0,
- "write_bytes_per_sec": 0,
- "writes_per_sec": 0
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "others_per_sec": 0,
- "read_bytes_per_sec": 0,
- "reads_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_op": 0,
- "usec_per_write_op": 0,
- "write_bytes_per_sec": 0,
- "writes_per_sec": 0
}
]
}GET buckets/bucket-access-policies
List a policy for the specified bucket and its attributes. Either names or
bucket_names/bucket_ids query parameters can be used.
Authorizations:
query Parameters
| allow_errors | boolean Default: false If set to |
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": [
- {
- "name": "string",
- "actions": [
- "s3:GetObject"
], - "effect": "allow",
- "principals": {
- "all": true
}, - "resources": [
- "mybucket/*"
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}
]
}POST buckets/bucket-access-policies
Create a new policy for the specified bucket. Policy's name will be autogenerated by the system.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (BucketAccessPolicyRuleBulkManage) |
Responses
Request samples
- Payload
{- "rules": [
- {
- "actions": [
- "s3:GetObject"
], - "principals": {
- "all": true
}, - "resources": [
- "mybucket/*"
], - "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": [
- {
- "name": "string",
- "actions": [
- "s3:GetObject"
], - "effect": "allow",
- "principals": {
- "all": true
}, - "resources": [
- "mybucket/*"
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}
]
}DELETE buckets/bucket-access-policies
Delete a bucket policy of the specified bucket. Either names or bucket_names/bucket_ids
query parameters can be used.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET buckets/bucket-access-policies/rules
List bucket policy rules for the specified bucket and their attributes. Either policy_names
or bucket_names/bucket_ids query parameters can be used.
Authorizations:
query Parameters
| allow_errors | boolean Default: false If set to |
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "name": "string",
- "actions": [
- "s3:GetObject"
], - "effect": "allow",
- "principals": {
- "all": true
}, - "resources": [
- "mybucket/*"
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST buckets/bucket-access-policies/rules
Create a new bucket policy rule for the specified bucket. Either policy_names
or bucket_names/bucket_ids query parameters can be used.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names. |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| actions | Array of strings The list of actions granted by this rule. Each included action may
restrict other properties of the rule.
The only currently supported action is |
object (BucketAccessPolicyRulePrincipal) The principals to which this rule applies. Currently, only all principals are supported. | |
| resources | Array of strings The list of resources which this rule applies to. The only currently supported resource is all objects in a bucket to which the parent policy belongs. |
Responses
Request samples
- Payload
{- "actions": [
- "s3:GetObject"
], - "principals": {
- "all": true
}, - "resources": [
- "mybucket/*"
]
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "actions": [
- "s3:GetObject"
], - "effect": "allow",
- "principals": {
- "all": true
}, - "resources": [
- "mybucket/*"
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE buckets/bucket-access-policies/rules
Delete one or more bucket policy rules for the specified bucket. Either policy_names
or bucket_names/bucket_ids query parameters can be used.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET buckets/s3-specific-performance
List performance metrics specific to S3 operations for a bucket.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "others_per_sec": 0,
- "read_buckets_per_sec": 0,
- "read_objects_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_bucket_op": 0,
- "usec_per_read_object_op": 0,
- "usec_per_write_bucket_op": 0,
- "usec_per_write_object_op": 0,
- "write_buckets_per_sec": 0,
- "write_objects_per_sec": 0
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "others_per_sec": 0,
- "read_buckets_per_sec": 0,
- "read_objects_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_bucket_op": 0,
- "usec_per_read_object_op": 0,
- "usec_per_write_bucket_op": 0,
- "usec_per_write_object_op": 0,
- "write_buckets_per_sec": 0,
- "write_objects_per_sec": 0
}
]
}Object replication requires a replica link that connects a source bucket to a remote bucket. The configuration of a replica link includes remote credentials, bucket names, remote names, replication status information, and cascading state.
GET bucket-replica-links
List bucket replica links for object replication.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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_bucket_ids | Array of strings A comma-separated list of local bucket IDs. If after filtering, there is
not at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with the |
| local_bucket_names | Array of strings A comma-separated list of local bucket names. If there is not at least one
resource that matches each of the elements, then an error is returned. This
cannot be provided together with |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| remote_bucket_names | Array of strings A comma-separated list of remote bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. |
| remote_ids | Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one
resource that matches each of the elements, then an error is returned. This cannot be provided
together with the |
| remote_names | 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 Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "direction": "string",
- "lag": 0,
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "cascading_enabled": true,
- "local_bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}, - "paused": true,
- "recovery_point": 1565034592494,
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote_bucket": {
- "name": "string"
}, - "remote_credentials": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string"
}
], - "total": {
- "id": "string",
- "direction": "string",
- "lag": 0,
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "cascading_enabled": true,
- "local_bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}, - "paused": true,
- "recovery_point": 1565034592494,
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote_bucket": {
- "name": "string"
}, - "remote_credentials": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string"
}
}POST bucket-replica-links
Create a bucket replica link for object replication.
Authorizations:
query Parameters
| 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_bucket_ids | Array of strings A comma-separated list of local bucket IDs. If after filtering, there is
not at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with the |
| local_bucket_names | Array of strings A comma-separated list of local bucket names. If there is not at least one
resource that matches each of the elements, then an error is returned. This
cannot be provided together with |
| remote_bucket_names | Array of strings A comma-separated list of remote bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. |
| remote_credentials_ids | Array of strings A comma-separated list of remote credentials 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_credentials_names | Array of strings A comma-separated list of remote credentials names. If 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| cascading_enabled | boolean If set to |
| paused | boolean Create link in the paused state? Defaults to |
Responses
Request samples
- Payload
{- "cascading_enabled": true,
- "paused": true
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "direction": "string",
- "lag": 0,
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "cascading_enabled": true,
- "local_bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}, - "paused": true,
- "recovery_point": 1565034592494,
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote_bucket": {
- "name": "string"
}, - "remote_credentials": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string"
}
], - "total": {
- "id": "string",
- "direction": "string",
- "lag": 0,
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "cascading_enabled": true,
- "local_bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}, - "paused": true,
- "recovery_point": 1565034592494,
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote_bucket": {
- "name": "string"
}, - "remote_credentials": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string"
}
}DELETE bucket-replica-links
Delete a bucket replica link.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| local_bucket_ids | Array of strings A comma-separated list of local bucket IDs. If after filtering, there is
not at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with the |
| local_bucket_names | Array of strings A comma-separated list of local bucket names. If there is not at least one
resource that matches each of the elements, then an error is returned. This
cannot be provided together with |
| remote_bucket_names | Array of strings A comma-separated list of remote bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. |
| remote_ids | Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one
resource that matches each of the elements, then an error is returned. This cannot be provided
together with the |
| remote_names | 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH bucket-replica-links
Modify the configuration of a bucket replica link including whether the link is paused and the object store remote credentials used.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| local_bucket_ids | Array of strings A comma-separated list of local bucket IDs. If after filtering, there is
not at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with the |
| local_bucket_names | Array of strings A comma-separated list of local bucket names. If there is not at least one
resource that matches each of the elements, then an error is returned. This
cannot be provided together with |
| remote_bucket_names | Array of strings A comma-separated list of remote bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. |
| remote_ids | Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one
resource that matches each of the elements, then an error is returned. This cannot be provided
together with the |
| remote_names | 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (FixedReference) Reference to a local bucket. | |
object (ObjectBacklog) The number of pending operations and their size that are currently in the backlog. | |
| paused | boolean Is the replica link paused? |
object (FixedReference) Reference to the associated remote, which can either be a | |
object (FixedReferenceNameOnly) Reference to a remote bucket. | |
object (ReferenceWritable) Reference to a remote-credentials object to access the remote bucket. |
Responses
Request samples
- Payload
{- "local_bucket": { },
- "object_backlog": { },
- "paused": true,
- "remote": { },
- "remote_bucket": { },
- "remote_credentials": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "direction": "string",
- "lag": 0,
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "cascading_enabled": true,
- "local_bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}, - "paused": true,
- "recovery_point": 1565034592494,
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote_bucket": {
- "name": "string"
}, - "remote_credentials": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string"
}
], - "total": {
- "id": "string",
- "direction": "string",
- "lag": 0,
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "cascading_enabled": true,
- "local_bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}, - "paused": true,
- "recovery_point": 1565034592494,
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote_bucket": {
- "name": "string"
}, - "remote_credentials": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string"
}
}Purity//FB 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.
GET certificates
List array certificates and their attributes.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "certificate": "string",
- "certificate_type": "string",
- "common_name": "string",
- "country": "Canada",
- "email": "tcrisp@example.com",
- "intermediate_certificate": "string",
- "issued_by": "Example Incorporated",
- "issued_to": "Pure Storage, Inc.",
- "key_size": 2048,
- "locality": "Toronto",
- "organization": "Veridian Dynamics",
- "organizational_unit": "Research & Development",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "state": "Ontario",
- "status": "string",
- "subject_alternative_names": [
- "otherdnsname.mydomain.com"
], - "valid_from": "string",
- "valid_to": "string"
}
]
}POST certificates
Upload a CA certificate to the array.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| certificate | string The text of the certificate. |
| certificate_type | string The type of certificate. Possible values are |
| intermediate_certificate | string Intermediate certificate chains. |
| passphrase | string The passphrase used to encrypt |
| private_key | string The private key used to sign the certificate. |
Responses
Request samples
- Payload
{- "certificate": "string",
- "certificate_type": "string",
- "intermediate_certificate": "string",
- "passphrase": "string",
- "private_key": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "certificate": "string",
- "certificate_type": "string",
- "common_name": "string",
- "country": "Canada",
- "email": "tcrisp@example.com",
- "intermediate_certificate": "string",
- "issued_by": "Example Incorporated",
- "issued_to": "Pure Storage, Inc.",
- "key_size": 2048,
- "locality": "Toronto",
- "organization": "Veridian Dynamics",
- "organizational_unit": "Research & Development",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "state": "Ontario",
- "status": "string",
- "subject_alternative_names": [
- "otherdnsname.mydomain.com"
], - "valid_from": "string",
- "valid_to": "string"
}
]
}DELETE certificates
Delete a CA certificate from the array.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH certificates
Modify SSL certificate attributes such as passphrases and intermediate certificates.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| certificate | string The text of the certificate. |
| intermediate_certificate | string Intermediate certificate chains. |
| passphrase | string The passphrase used to encrypt |
| private_key | string The private key used to sign the certificate. |
Responses
Request samples
- Payload
{- "certificate": "string",
- "intermediate_certificate": "string",
- "passphrase": "string",
- "private_key": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "certificate": "string",
- "certificate_type": "string",
- "common_name": "string",
- "country": "Canada",
- "email": "tcrisp@example.com",
- "intermediate_certificate": "string",
- "issued_by": "Example Incorporated",
- "issued_to": "Pure Storage, Inc.",
- "key_size": 2048,
- "locality": "Toronto",
- "organization": "Veridian Dynamics",
- "organizational_unit": "Research & Development",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "state": "Ontario",
- "status": "string",
- "subject_alternative_names": [
- "otherdnsname.mydomain.com"
], - "valid_from": "string",
- "valid_to": "string"
}
]
}GET certificates/certificate-groups
List membership associations between groups and certificates.
Authorizations:
query Parameters
| certificate_group_ids | Array of strings A comma-separated list of certificate group ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_group_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 A comma-separated list of certificate names.
If there is not at least one resource that matches each of the
elements of |
| 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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST certificates/certificate-groups
Add one or more certificates to one or more certificate groups.
Authorizations:
query Parameters
| certificate_group_ids | Array of strings A comma-separated list of certificate group ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_group_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 A comma-separated list of certificate names.
If there is not at least one resource that matches each of the
elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE certificates/certificate-groups
Remove one or more certificates from one or more certificate groups.
Authorizations:
query Parameters
| certificate_group_ids | Array of strings A comma-separated list of certificate group ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_group_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 A comma-separated list of certificate names.
If there is not at least one resource that matches each of the
elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET certificates/uses
List how certificates are being used and by what.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "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",
- "remote": {
- "id": "string",
- "name": "string"
}
}
}
]
}Certificate Groups can contain one or more CA certificates for verifying an LDAP server identity and establish communication over TLS.
GET certificate-groups
Display all array certificate groups.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}POST certificate-groups
Create one or more certificate groups on the array.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}DELETE certificate-groups
Delete one or more certificate groups from the array.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET certificate-groups/certificates
List membership associations between groups and certificates on the array.
Authorizations:
query Parameters
| certificate_group_ids | Array of strings A comma-separated list of certificate group ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_group_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 A comma-separated list of certificate names.
If there is not at least one resource that matches each of the
elements of |
| 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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST certificate-groups/certificates
Add one or more certificates to one or more certificate groups on the array.
Authorizations:
query Parameters
| certificate_group_ids | Array of strings A comma-separated list of certificate group ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_group_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 A comma-separated list of certificate names.
If there is not at least one resource that matches each of the
elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE certificate-groups/certificates
Delete one or more certificate groups.
Authorizations:
query Parameters
| certificate_group_ids | Array of strings A comma-separated list of certificate group ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_group_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 A comma-separated list of certificate names.
If there is not at least one resource that matches each of the
elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET certificate-groups/uses
List how certificate groups are being used and by what.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "use": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "remote": {
- "id": "string",
- "name": "string"
}
}
}
]
}Displays an NFS client’s performance metrics on the array for read, write, and meta operations.
GET clients-performance
List client performance metrics.
Authorizations:
query Parameters
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| limit | integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page.
To return the total number of resources, set |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| protocol | string Display the performance of a specified protocol.
Valid values are |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "others_per_sec": 0,
- "read_bytes_per_sec": 0,
- "reads_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_op": 0,
- "usec_per_write_op": 0,
- "write_bytes_per_sec": 0,
- "writes_per_sec": 0
}
], - "total": [
- {
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "others_per_sec": 0,
- "read_bytes_per_sec": 0,
- "reads_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_op": 0,
- "usec_per_write_op": 0,
- "write_bytes_per_sec": 0,
- "writes_per_sec": 0
}
]
}GET clients-performance
List S3 client performance performance metrics.
Authorizations:
query Parameters
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| limit | integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page.
To return the total number of resources, set |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "others_per_sec": 0,
- "read_buckets_per_sec": 0,
- "read_objects_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_bucket_op": 0,
- "usec_per_read_object_op": 0,
- "usec_per_write_bucket_op": 0,
- "usec_per_write_object_op": 0,
- "write_buckets_per_sec": 0,
- "write_objects_per_sec": 0
}
], - "total": [
- {
- "name": "string",
- "others_per_sec": 0,
- "read_buckets_per_sec": 0,
- "read_objects_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_bucket_op": 0,
- "usec_per_read_object_op": 0,
- "usec_per_write_bucket_op": 0,
- "usec_per_write_object_op": 0,
- "write_buckets_per_sec": 0,
- "write_objects_per_sec": 0
}
]
}Manages directory service configurations for integration with LDAP servers (e.g. Active Directory and OpenLDAP) in order to support various array services.
GET directory-services
List directory service configuration information.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "base_dn": "DC=mycompany,DC=com",
- "bind_password": "****",
- "bind_user": "CN=John,OU=Users,DC=example,DC=com",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "enabled": true,
- "management": {
- "user_login_attribute": "email",
- "user_object_class": "inetOrgPerson"
}, - "nfs": {
- "nis_domains": [
- "ypdomain"
], - "nis_servers": [
- "181.44.543.12"
]
}, - "services": [
- "management"
], - "smb": {
- "join_ou": "OU=my_organizational_unit"
}, - "uris": [
- "ldaps://ad1.mycompany.com"
]
}
]
}PATCH directory-services
Modifies and tests the directory service configuration.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| base_dn | string Base of the Distinguished Name (DN) of the directory service groups. |
| bind_password | string Obfuscated password used to query the directory. |
| bind_user | string Username used to query the directory. |
object (Reference) CA certificate used to validate the authenticity of the configured servers. | |
object (Reference) A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers. | |
| enabled | boolean Is the directory service enabled or not? |
object (_directoryServiceManagement) Properties specific to the management service. | |
object (_directoryServiceNfs) Properties specific to the NFS service. | |
object (_directoryServiceSmb) DEPRECATED - Properties specific to the SMB service. | |
| uris | Array of strings <= 30 items List of URIs for the configured directory servers. |
Responses
Request samples
- Payload
{- "base_dn": "DC=mycompany,DC=com",
- "bind_password": "****",
- "bind_user": "CN=John,OU=Users,DC=example,DC=com",
- "ca_certificate": {
- "id": "string",
- "name": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string"
}, - "enabled": true,
- "management": {
- "user_login_attribute": "email",
- "user_object_class": "inetOrgPerson"
}, - "nfs": {
- "nis_domains": [
- "ypdomain"
], - "nis_servers": [
- "181.44.543.12"
]
}, - "smb": {
- "join_ou": "OU=my_organizational_unit"
}, - "uris": [
- "ldaps://ad1.mycompany.com"
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "base_dn": "DC=mycompany,DC=com",
- "bind_password": "****",
- "bind_user": "CN=John,OU=Users,DC=example,DC=com",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "enabled": true,
- "management": {
- "user_login_attribute": "email",
- "user_object_class": "inetOrgPerson"
}, - "nfs": {
- "nis_domains": [
- "ypdomain"
], - "nis_servers": [
- "181.44.543.12"
]
}, - "services": [
- "management"
], - "smb": {
- "join_ou": "OU=my_organizational_unit"
}, - "uris": [
- "ldaps://ad1.mycompany.com"
]
}
]
}GET directory-service/roles
Return array's RBAC group configuration settings for manageability.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| role_ids | Array of strings A comma-separated list of role_ids.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_names | Array of strings A comma-separated list of role_names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "id": "string",
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "name": "string",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST directory-service/roles
Create an RBAC group configuration setting for manageability.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| group | string Common Name (CN) of the directory service group containing users with authority level of the specified role name. |
| group_base | string Specifies where the configured group is located in the directory tree. |
object (ReferenceWritable) Deprecated.
|
Responses
Request samples
- Payload
{- "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}Response samples
- 200
{- "items": [
- {
- "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "id": "string",
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "name": "string",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE directory-service/roles
Delete an RBAC group configuration setting for manageability.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH directory-service/roles
Update an RBAC group configuration setting for manageability.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_ids | Array of strings A comma-separated list of role_ids.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_names | Array of strings A comma-separated list of role_names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| group | string Common Name (CN) of the directory service group containing users with authority level of the specified role name. |
| group_base | string Specifies where the configured group is located in the directory tree. |
object (ReferenceWritable) Deprecated.
|
Responses
Request samples
- Payload
{- "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}Response samples
- 200
{- "items": [
- {
- "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "id": "string",
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "name": "string",
- "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}GET directory-services/test
Test the configured directory services on the array.
Authorizations:
query Parameters
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
], - "total_item_count": 0
}PATCH directory-service/test
Test the configured directory services on the array. Optionally, provide modifications which will be used to perform the tests, but will not be applied to the current configuration.
Authorizations:
query Parameters
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
An optional directory service configuration that, if provided, will be used to overwrite aspects of the existing directory service objects when performing tests.
| base_dn | string Base of the Distinguished Name (DN) of the directory service groups. |
| bind_password | string Obfuscated password used to query the directory. |
| bind_user | string Username used to query the directory. |
object (Reference) CA certificate used to validate the authenticity of the configured servers. | |
object (Reference) A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers. | |
| enabled | boolean Is the directory service enabled or not? |
object (_directoryServiceManagement) Properties specific to the management service. | |
object (_directoryServiceNfs) Properties specific to the NFS service. | |
object (_directoryServiceSmb) DEPRECATED - Properties specific to the SMB service. | |
| uris | Array of strings <= 30 items List of URIs for the configured directory servers. |
Responses
Request samples
- Payload
{- "base_dn": "DC=mycompany,DC=com",
- "bind_password": "****",
- "bind_user": "CN=John,OU=Users,DC=example,DC=com",
- "ca_certificate": {
- "id": "string",
- "name": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string"
}, - "enabled": true,
- "management": {
- "user_login_attribute": "email",
- "user_object_class": "inetOrgPerson"
}, - "nfs": {
- "nis_domains": [
- "ypdomain"
], - "nis_servers": [
- "181.44.543.12"
]
}, - "smb": {
- "join_ou": "OU=my_organizational_unit"
}, - "uris": [
- "ldaps://ad1.mycompany.com"
]
}Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
]
}Manages the Domain Name System (DNS) attributes, including the domain suffix and static name servers. The configured attributes can be listed.
GET dns
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.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "domain": "example.com",
- "nameservers": [
- ""
], - "services": [
- "string"
], - "sources": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}POST dns
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.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| domain | string Domain suffix to be appended by the appliance when performing DNS lookups. |
| nameservers | Array of strings <= 3 items List of DNS server IP addresses. |
| services | Array of strings The list of services utilizing the DNS configuration. |
Array of objects (_reference) <= 1 items The network interfaces used for communication with the DNS server.
The network interfaces must have the |
Responses
Request samples
- Payload
{- "domain": "example.com",
- "nameservers": [
- ""
], - "services": [
- "string"
], - "sources": [
- {
- "id": "string",
- "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "domain": "example.com",
- "nameservers": [
- ""
], - "services": [
- "string"
], - "sources": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}DELETE dns
Deletes a DNS configuration.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH dns
Modify a DNS configuration.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| domain | string Domain suffix to be appended by the appliance when performing DNS lookups. |
| nameservers | Array of strings <= 3 items List of DNS server IP addresses. |
| services | Array of strings The list of services utilizing the DNS configuration. |
Array of objects (_reference) <= 1 items The network interfaces used for communication with the DNS server.
The network interfaces must have the |
Responses
Request samples
- Payload
{- "name": "string",
- "domain": "example.com",
- "nameservers": [
- ""
], - "services": [
- "string"
], - "sources": [
- {
- "id": "string",
- "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "domain": "example.com",
- "nameservers": [
- ""
], - "services": [
- "string"
], - "sources": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}Displays detailed information for each drive in the array. Drives are not used in all hardware platforms, and are currently only present in the FlashBlade//S and FlashBlade//E product lines.
GET drives
List array drive information.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "details": "string",
- "progress": 0,
- "raw_capacity": 0,
- "status": "string",
- "type": "DFM"
}
], - "total": {
- "id": "string",
- "name": "string",
- "details": "string",
- "progress": 0,
- "raw_capacity": 0,
- "status": "string",
- "type": "DFM"
}
}GET file-systems
List one or more file systems on the array.
Authorizations:
query Parameters
| 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) are specified in the |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "default_group_quota": 0,
- "default_user_quota": 0,
- "destroyed": true,
- "eradication_config": {
- "eradication_mode": "permission-based",
- "manual_eradication": "enabled"
}, - "fast_remove_directory_enabled": true,
- "group_ownership": "string",
- "hard_limit_enabled": true,
- "http": {
- "enabled": true
}, - "multi_protocol": {
- "access_control_style": "string",
- "safeguard_acls": true
}, - "nfs": {
- "export_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": "1.0.0.0/8(rw,no_root_squash) fd01:abcd::/64(ro,secure,root_squash,anongid=16000) @netgrp(rw,all_squash,anonuid=99,fileid_32bit) 1.41.8.32(rw,no_all_squash,sec=krb5:krb5i:krp5p) my-hostname(rw,no_root_squash) host.exampledomain.com(rw,no_root_squash) host?(rw,no_root_squash) host?.example*domain.com(rw,no_root_squash) host.*(rw,no_root_squash)",
- "v3_enabled": true,
- "v4_1_enabled": true
}, - "node_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "promotion_status": "string",
- "provisioned": 1048576,
- "qos_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "requested_promotion_state": "string",
- "smb": {
- "client_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_availability_enabled": true,
- "enabled": true,
- "share_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "snapshot_directory_enabled": true,
- "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": {
- "name": "string",
- "status": "string",
- "status_details": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "time_remaining": 0,
- "writable": true
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "total": {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "default_group_quota": 0,
- "default_user_quota": 0,
- "destroyed": true,
- "eradication_config": {
- "eradication_mode": "permission-based",
- "manual_eradication": "enabled"
}, - "fast_remove_directory_enabled": true,
- "group_ownership": "string",
- "hard_limit_enabled": true,
- "http": {
- "enabled": true
}, - "multi_protocol": {
- "access_control_style": "string",
- "safeguard_acls": true
}, - "nfs": {
- "export_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": "1.0.0.0/8(rw,no_root_squash) fd01:abcd::/64(ro,secure,root_squash,anongid=16000) @netgrp(rw,all_squash,anonuid=99,fileid_32bit) 1.41.8.32(rw,no_all_squash,sec=krb5:krb5i:krp5p) my-hostname(rw,no_root_squash) host.exampledomain.com(rw,no_root_squash) host?(rw,no_root_squash) host?.example*domain.com(rw,no_root_squash) host.*(rw,no_root_squash)",
- "v3_enabled": true,
- "v4_1_enabled": true
}, - "node_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "promotion_status": "string",
- "provisioned": 1048576,
- "qos_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "requested_promotion_state": "string",
- "smb": {
- "client_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_availability_enabled": true,
- "enabled": true,
- "share_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "snapshot_directory_enabled": true,
- "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": {
- "name": "string",
- "status": "string",
- "status_details": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "time_remaining": 0,
- "writable": true
}
}POST file-systems
Create a file system on the current array.
Authorizations:
query Parameters
| 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 |
| default_exports | Array of strings Example: default_exports=nfs,smb A comma-separated list of export types to be created using default access.
Creating a file system with an explicit |
| discard_non_snapshotted_data | boolean This parameter must be set to |
| names required | Array of strings A comma-separated list of resource names. |
| overwrite | boolean When used for snapshot restore, overwrites ( |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| default_group_quota | integer <int64> The default space quota for a group writing to this file system. |
| default_user_quota | integer <int64> The default space quota for a user writing to this file system. |
object (_fileSystemEradicationConfig) Configuration settings related to file system eradication. | |
| fast_remove_directory_enabled | boolean If set to |
| group_ownership | string The group ownership for new files and directories in a file system.
Possible values are |
| hard_limit_enabled | boolean If set to |
object (Http) HTTP configuration. | |
object (MultiProtocolPost) Multi-protocol configuration. | |
object (Nfs) NFS configuration. | |
object (Reference) The node group's nodes are where the file system's files are stored. Used only on hardware platforms supporting nodes. | |
| provisioned | integer <int64> The provisioned size of the file system, displayed in bytes. If set to an
empty string ( |
object (Reference) The QoS policy for the File System defines the performance controls that can be applied to the aggregate performance of all the clients accessing the file system. If no policy is set here, no explicit performance controls are applied to the file system beyond the system's default fairness. | |
object (SmbPost) SMB configuration. | |
| snapshot_directory_enabled | boolean If set to |
object (Reference) The source snapshot whose data is copied to the file system specified. | |
| writable | boolean Whether the file system is writable or not. If |
Responses
Request samples
- Payload
{- "default_group_quota": 0,
- "default_user_quota": 0,
- "eradication_config": {
- "eradication_mode": "permission-based"
}, - "fast_remove_directory_enabled": true,
- "group_ownership": "string",
- "hard_limit_enabled": true,
- "http": {
- "enabled": true
}, - "multi_protocol": {
- "access_control_style": "string",
- "safeguard_acls": true
}, - "nfs": {
- "export_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": "1.0.0.0/8(rw,no_root_squash) fd01:abcd::/64(ro,secure,root_squash,anongid=16000) @netgrp(rw,all_squash,anonuid=99,fileid_32bit) 1.41.8.32(rw,no_all_squash,sec=krb5:krb5i:krp5p) my-hostname(rw,no_root_squash) host.exampledomain.com(rw,no_root_squash) host?(rw,no_root_squash) host?.example*domain.com(rw,no_root_squash) host.*(rw,no_root_squash)",
- "v3_enabled": true,
- "v4_1_enabled": true
}, - "node_group": {
- "id": "string",
- "name": "string"
}, - "provisioned": 0,
- "qos_policy": {
- "id": "string",
- "name": "string"
}, - "smb": {
- "client_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_availability_enabled": true,
- "enabled": true,
- "share_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "snapshot_directory_enabled": true,
- "source": {
- "id": "string",
- "name": "string"
}, - "writable": true
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "default_group_quota": 0,
- "default_user_quota": 0,
- "destroyed": true,
- "eradication_config": {
- "eradication_mode": "permission-based",
- "manual_eradication": "enabled"
}, - "fast_remove_directory_enabled": true,
- "group_ownership": "string",
- "hard_limit_enabled": true,
- "http": {
- "enabled": true
}, - "multi_protocol": {
- "access_control_style": "string",
- "safeguard_acls": true
}, - "nfs": {
- "export_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": "1.0.0.0/8(rw,no_root_squash) fd01:abcd::/64(ro,secure,root_squash,anongid=16000) @netgrp(rw,all_squash,anonuid=99,fileid_32bit) 1.41.8.32(rw,no_all_squash,sec=krb5:krb5i:krp5p) my-hostname(rw,no_root_squash) host.exampledomain.com(rw,no_root_squash) host?(rw,no_root_squash) host?.example*domain.com(rw,no_root_squash) host.*(rw,no_root_squash)",
- "v3_enabled": true,
- "v4_1_enabled": true
}, - "node_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "promotion_status": "string",
- "provisioned": 1048576,
- "qos_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "requested_promotion_state": "string",
- "smb": {
- "client_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_availability_enabled": true,
- "enabled": true,
- "share_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "snapshot_directory_enabled": true,
- "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": {
- "name": "string",
- "status": "string",
- "status_details": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "time_remaining": 0,
- "writable": true
}
]
}DELETE file-systems
Deletes a file system. Deleting a file system is equivalent to eradication. A file system's destroyed parameter must be set to true before a file system can be deleted.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH file-systems
Modify a file system's attributes including its export protocols and limits.
Authorizations:
query Parameters
| cancel_in_progress_storage_class_transition | 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 |
| delete_link_on_eradication | boolean If set to |
| discard_detailed_permissions | boolean This parameter must be set to |
| discard_non_snapshotted_data | boolean This parameter must be set to |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| ignore_usage | boolean Allow update operations that lead to a |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| default_group_quota | integer <int64> The default space quota for a group writing to this file system. |
| default_user_quota | integer <int64> The default space quota for a user writing to this file system. |
| destroyed | boolean Returns a value of |
| fast_remove_directory_enabled | boolean If set to |
| group_ownership | string The group ownership for new files and directories in a file system.
Possible values are |
| hard_limit_enabled | boolean If set to |
object (Http) HTTP configuration. | |
object (MultiProtocol) Multi-protocol configuration. | |
object (NfsPatch) NFS configuration. | |
| provisioned | integer <int64> The provisioned size of the file system, displayed in bytes. If set to an
empty string ( |
object (Reference) The QoS policy for the File System defines the performance controls that can be applied to the aggregate performance of all the clients accessing the file system. If no policy is configured for a file system, then no performance controls are applied to it. Use "" to clear an attached policy. | |
| requested_promotion_state | string Possible values are |
object (Smb) SMB configuration. | |
| snapshot_directory_enabled | boolean If set to |
object (FixedLocationReference) A reference to the source file system. | |
object (StorageClassInfo) | |
| writable | boolean Whether the file system is writable or not. If |
Responses
Request samples
- Payload
{- "name": "string",
- "default_group_quota": 0,
- "default_user_quota": 0,
- "destroyed": true,
- "fast_remove_directory_enabled": true,
- "group_ownership": "string",
- "hard_limit_enabled": true,
- "http": {
- "enabled": true
}, - "multi_protocol": {
- "access_control_style": "string",
- "safeguard_acls": true
}, - "nfs": {
- "export_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": "1.0.0.0/8(rw,no_root_squash) fd01:abcd::/64(ro,secure,root_squash,anongid=16000) @netgrp(rw,all_squash,anonuid=99,fileid_32bit) 1.41.8.32(rw,no_all_squash,sec=krb5:krb5i:krp5p) my-hostname(rw,no_root_squash) host.exampledomain.com(rw,no_root_squash) host?(rw,no_root_squash) host?.example*domain.com(rw,no_root_squash) host.*(rw,no_root_squash)",
- "v3_enabled": true,
- "v4_1_enabled": true,
- "add_rules": "string",
- "after": "string",
- "remove_rules": "string"
}, - "provisioned": 1048576,
- "qos_policy": {
- "id": "string",
- "name": "string"
}, - "requested_promotion_state": "string",
- "smb": {
- "client_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_availability_enabled": true,
- "enabled": true,
- "share_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "snapshot_directory_enabled": true,
- "source": {
- "location": { }
}, - "storage_class": {
- "name": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string"
}
}, - "writable": true
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "default_group_quota": 0,
- "default_user_quota": 0,
- "destroyed": true,
- "eradication_config": {
- "eradication_mode": "permission-based",
- "manual_eradication": "enabled"
}, - "fast_remove_directory_enabled": true,
- "group_ownership": "string",
- "hard_limit_enabled": true,
- "http": {
- "enabled": true
}, - "multi_protocol": {
- "access_control_style": "string",
- "safeguard_acls": true
}, - "nfs": {
- "export_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": "1.0.0.0/8(rw,no_root_squash) fd01:abcd::/64(ro,secure,root_squash,anongid=16000) @netgrp(rw,all_squash,anonuid=99,fileid_32bit) 1.41.8.32(rw,no_all_squash,sec=krb5:krb5i:krp5p) my-hostname(rw,no_root_squash) host.exampledomain.com(rw,no_root_squash) host?(rw,no_root_squash) host?.example*domain.com(rw,no_root_squash) host.*(rw,no_root_squash)",
- "v3_enabled": true,
- "v4_1_enabled": true
}, - "node_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "promotion_status": "string",
- "provisioned": 1048576,
- "qos_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "requested_promotion_state": "string",
- "smb": {
- "client_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_availability_enabled": true,
- "enabled": true,
- "share_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "snapshot_directory_enabled": true,
- "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": {
- "name": "string",
- "status": "string",
- "status_details": "string",
- "tiering_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "time_remaining": 0,
- "writable": true
}
]
}GET file-systems/groups/performance
List a group’s I/O performance metrics on a file system.
Authorizations:
query Parameters
| file_system_ids | Array of strings A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| gids | Array of strings A comma-separated list of group IDs.
This cannot be provided together with |
| group_names | Array of strings A comma-separated list of group names.
This cannot be provided together with |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "id": 0,
- "name": "string"
}, - "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": [
- {
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "id": 0,
- "name": "string"
}, - "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
}
]
}GET file-systems/performance
Displays the performance metrics for a file system.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| protocol | string Display the performance of a specified protocol.
Valid values are |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "others_per_sec": 0,
- "read_bytes_per_sec": 0,
- "reads_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_op": 0,
- "usec_per_write_op": 0,
- "write_bytes_per_sec": 0,
- "writes_per_sec": 0
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "others_per_sec": 0,
- "read_bytes_per_sec": 0,
- "reads_per_sec": 0,
- "time": 0,
- "usec_per_other_op": 0,
- "usec_per_read_op": 0,
- "usec_per_write_op": 0,
- "write_bytes_per_sec": 0,
- "writes_per_sec": 0
}
]
}GET file-systems/audit-policies
List file systems mapped to a audit policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST file-systems/audit-policies
Map a audit policy to a file system.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE file-systems/audit-policies
Remove the audit policy mapped to a file system.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET file-systems/policies
List file system snapshot scheduling policies. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST file-systems/policies
Apply a snapshot scheduling policy to a file system. Only one file system can be mapped to a policy at a time.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE file-systems/policies
Remove a snapshot scheduling policy from a file system.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET file-systems/policies-all
List file system policies. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}GET file-systems/users/performance
List a user’s I/O performance metrics on a file system.
Authorizations:
query Parameters
| file_system_ids | Array of strings A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
| uids | Array of integers <int32> A comma-separated list of user IDs.
This cannot be provided together with |
| user_names | Array of strings A comma-separated list of user names.
This cannot be provided together with |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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,
- "user": {
- "id": 0,
- "name": "string"
}, - "write_bytes_per_sec": 0,
- "writes_per_sec": 0
}
], - "total": [
- {
- "name": "string",
- "bytes_per_op": 0,
- "bytes_per_read": 0,
- "bytes_per_write": 0,
- "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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,
- "user": {
- "id": 0,
- "name": "string"
}, - "write_bytes_per_sec": 0,
- "writes_per_sec": 0
}
]
}GET file-systems/worm-data-policies
List file systems mapped to a WORM data policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}Get a list of active file locks
Lists all active file locks that satisfy the conditions specified by the parameters.
Authorizations:
query Parameters
| client_names | Array of strings A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported. |
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| inodes | Array of numbers A comma-separated list of inodes used for filtering file locks query by inodes.
This may only be specified if |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| paths | Array of strings A comma-separated list of paths used for filtering file locks query by paths.
This may only be specified if |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "access_type": "string",
- "client": {
- "name": "string",
- "resource_type": "string"
}, - "created_at": 0,
- "inode": 0,
- "path": "string",
- "protocol": "string",
- "range": {
- "length": 0,
- "offset": 0
}, - "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Invalidate file locks
Invalidates file locks. It can be used to either delete an individual lock
by name or multiple locks filtered by parameters. E.g. to delete locks held
by a client on specific file, parameters client_names, file_system_ids or
file_system_names and path must be specified.
When names is specified, no other query parameter can be specified.
Authorizations:
query Parameters
| client_names | Array of strings A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported. |
| file_system_ids | Array of strings A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| inodes | Array of numbers A comma-separated list of inodes used for filtering file locks query by inodes.
This may only be specified if |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| paths | Array of strings A comma-separated list of paths used for filtering file locks query by paths.
This may only be specified if |
| recursive | boolean Flag used to indicate that the action should be done recursively.
If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Get a list of clients that hold active file locks
Lists all clients that hold active file locks.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string"
}
]
}Initiate NLM reclamation.
NLM reclamation is a system-wide operation, affecting all clients, and so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "end": 0,
- "start": 0
}
]
}Get a list of active sessions
Lists all active sessions that satisfy the conditions specified by the parameters.
Authorizations:
query Parameters
| client_names | Array of strings A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported. |
| 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 |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| protocols | Array of strings A comma-separated list of file protocols.
Valid values include |
| user_names | Array of strings A comma-separated list of user names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "authentication": "string",
- "client": {
- "name": "string"
}, - "connection_time": 0,
- "idle_time": 0,
- "opens": 0,
- "port": 0,
- "protocol": "string",
- "time": 0,
- "user": {
- "name": "string"
}
}
]
}Delete sessions
Delete sessions. It can be used to either delete an individual session
by name or multiple sessions filtered by parameters. E.g. to delete SMBv3
sessions held by specific client, protocols and client_names must be
specified.
To prevent accidental deletes, setting flag disruptive to true
is required when only a single query parameter is part of the query.
E.g. to delete all SMBv3 sessions, query parameters protocols and
disruptive must be set.
When names is specified, no other query parameter can be specified.
Authorizations:
query Parameters
| client_names | Array of strings A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported. |
| disruptive | boolean If set to |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| protocols | Array of strings A comma-separated list of file protocols.
Valid values include |
| user_names | Array of strings A comma-separated list of user names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET file-systems/space/storage-classes
List available and used storage space per filesystem.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| storage_class_names | Array of strings A comma-separated list of storage class names. Valid values include |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": "string",
- "time": 0
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "storage_class": "string",
- "time": 0
}
]
}GET file-systems/open-files
List open files.
Authorizations:
query Parameters
| client_names | Array of strings A comma-separated list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported. |
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page.
To return the total number of resources, set |
| paths | Array of strings Example: paths=/fs1_export1/path/to/file1,/fs1_export1/path/to/file2 A comma-separated list of paths used for filtering open files query. |
| protocols required | Array of strings A comma-separated list of file protocols.
Valid values include |
| session_names | Array of strings A comma-separated list of session names used for filtering open files query. Files opened in any of the specified sessions will be returned. |
| user_names | Array of strings Example: user_names=DomainName\User1,DomainName\User2 A comma-separated list of user names used for filtering open files query. Files opened by any of the specified users will be returned. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "client": {
- "name": "string"
}, - "id": "18446744073709551615",
- "lock_count": 0,
- "mode": "string",
- "path": "/fs1_export1/path/to/file1.txt",
- "session": {
- "name": "string"
}, - "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "user": {
- "name": "string"
}
}
]
}DELETE file-systems/open-files
Close open file from given identifiers.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Manages the creation, attributes, and deletion of file system exports. Exports link either an NFS Export Policy or a SMB Client Policy, a file system, and a server.
GET file-system-exports
List one or more file system exports.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "enabled": true,
- "export_name": "string",
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "share_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string"
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST file-system-exports
Create a file system export.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| export_name | string The name of the export to create. Export names must be unique within the same protocol and server. |
object (Reference) Reference to the server the export will be visible on. | |
object (Reference) Reference to the SMB share policy (only used for SMB). |
Responses
Request samples
- Payload
{- "export_name": "string",
- "server": {
- "id": "string",
- "name": "string"
}, - "share_policy": {
- "id": "string",
- "name": "string"
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "enabled": true,
- "export_name": "string",
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "share_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string"
}
]
}DELETE file-system-exports
Deletes a file system export.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH file-system-exports
Modify a file system export’s attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| export_name | string The name of the export used by clients to mount the file system. Export names must be unique within the same protocol/server combination. |
object (FixedReference) Reference to the file system the policy is applied to. | |
object (Reference) Reference to the NFS export policy or SMB client policy. | |
object (FixedReference) Reference to the server the export will be visible on. | |
object (Reference) Reference to the SMB share policy (only used for SMB). |
Responses
Request samples
- Payload
{- "export_name": "string",
- "member": { },
- "policy": {
- "id": "string",
- "name": "string"
}, - "server": { },
- "share_policy": {
- "id": "string",
- "name": "string"
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "enabled": true,
- "export_name": "string",
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "share_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string"
}
]
}File system replication requires a replica link that connects a source array to a remote target. The configuration of a replica link includes policies, file system names, remote names, and replication status information.
GET file-system-replica-links
List file system replication link.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| remote_file_system_ids | Array of strings A comma-separated list of remote file system IDs. If 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_file_system_names | Array of strings A comma-separated list of remote file system names. If there is not at
least one resource that matches each of the elements, then an error is
returned. This cannot be provided together with the |
| remote_ids | 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 Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "direction": "string",
- "lag": 0,
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "link_type": "string",
- "local_file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "recovery_point": 1565034592494,
- "remote": {
- "id": "string",
- "name": "string"
}, - "remote_file_system": {
- "id": "string",
- "name": "string"
}, - "status": "string"
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST file-system-replica-links
Create a file system replication link.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| local_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| remote_file_system_names | Array of strings A comma-separated list of remote file system names. If there is not at
least one resource that matches each of the elements, then an error is
returned. This cannot be provided together with the |
| remote_ids | 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| link_type | string Type of the replica link.
Values include |
object (FixedReference) Reference to a local file system. | |
Array of objects (LocationReference) | |
object (FixedReferenceNoResourceType) Reference to a remote array. | |
object (FixedReferenceNoResourceType) Reference to a remote file system. |
Responses
Request samples
- Payload
{- "link_type": "string",
- "local_file_system": { },
- "policies": [
- {
- "id": "string",
- "name": "string",
- "location": {
- "id": "string",
- "name": "string"
}
}
], - "remote": { },
- "remote_file_system": { }
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "direction": "string",
- "lag": 0,
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "link_type": "string",
- "local_file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "recovery_point": 1565034592494,
- "remote": {
- "id": "string",
- "name": "string"
}, - "remote_file_system": {
- "id": "string",
- "name": "string"
}, - "status": "string"
}
]
}DELETE file-system-replica-links
Delete a file system replication link.
Authorizations:
query Parameters
| cancel_in_progress_transfers | boolean This parameter must be 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 |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| local_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| remote_file_system_ids | Array of strings A comma-separated list of remote file system IDs. If 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_file_system_names | Array of strings A comma-separated list of remote file system names. If there is not at
least one resource that matches each of the elements, then an error is
returned. This cannot be provided together with the |
| remote_ids | 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH file-system-replica-links
Update a file system replication link.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| local_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| 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 |
| replicate_now | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "direction": "string",
- "lag": 0,
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "link_type": "string",
- "local_file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "recovery_point": 1565034592494,
- "remote": {
- "id": "string",
- "name": "string"
}, - "remote_file_system": {
- "id": "string",
- "name": "string"
}, - "status": "string"
}
]
}GET file-system-replica-links/policies
List file system replication link policies.
Authorizations:
query Parameters
| 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 |
| local_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| remote_file_system_ids | Array of strings A comma-separated list of remote file system IDs. If 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_file_system_names | Array of strings A comma-separated list of remote file system names. If there is not at
least one resource that matches each of the elements, then an error is
returned. This cannot be provided together with the |
| remote_ids | 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 Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "link": {
- "local_file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote": {
- "id": "string",
- "name": "string"
}, - "remote_file_system": {
- "id": "string",
- "name": "string"
}
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST file-system-replica-links/policies
Add a policy to a file system replication link.
Authorizations:
query Parameters
| 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_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "link": {
- "local_file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote": {
- "id": "string",
- "name": "string"
}, - "remote_file_system": {
- "id": "string",
- "name": "string"
}
}
}
]
}DELETE file-system-replica-links/policies
Remove a policy from a file system replication link.
Authorizations:
query Parameters
| 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_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET file-system-replica-links/transfer
List the transfer status details for file system replication.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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_or_owner_names | Array of strings A comma-separated list of resource names. Either the names of the snapshots or the owning file systems. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| 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 Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "completed": 0,
- "data_transferred": 0,
- "direction": "string",
- "local_snapshot": {
- "id": "string",
- "name": "string"
}, - "progress": 0,
- "remote": {
- "id": "string",
- "name": "string"
}, - "remote_snapshot": {
- "id": "string",
- "name": "string"
}, - "started": 0,
- "status": "string"
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "total": {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "completed": 0,
- "data_transferred": 0,
- "direction": "string",
- "local_snapshot": {
- "id": "string",
- "name": "string"
}, - "progress": 0,
- "remote": {
- "id": "string",
- "name": "string"
}, - "remote_snapshot": {
- "id": "string",
- "name": "string"
}, - "started": 0,
- "status": "string"
}
}A file system snapshot is a point-in-time copy of a file system. Multiple snapshots of a file system can be copied for different points in time. A snapshot policy can also be applied to a file system for automatic creation and retention of snapshots. Additionally, file system snapshots can also be sent from one array to another.
GET file-system-snapshots
List file system snapshots. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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) are specified in the |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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_or_owner_names | Array of strings A comma-separated list of resource names. Either the names of the snapshots or the owning file systems. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| owner_ids | Array of strings A comma-separated list of owning file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of owner IDs, then an error is returned.
This cannot be provided together with the |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "owner": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "owner_destroyed": true,
- "policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "suffix": "snap1",
- "time_remaining": 0
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "total": {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "owner": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "owner_destroyed": true,
- "policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "suffix": "snap1",
- "time_remaining": 0
}
}POST file-system-snapshots
Create a snapshot for a specified source file system. If a source file system is not specified, creates snapshots for all file systems on the array.
Authorizations:
query Parameters
| 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 |
| send | boolean Whether to replicate created snapshots immediately to other arrays.
If it's |
| source_ids | Array of strings A comma-separated list of source file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| source_names | Array of strings A comma-separated list of names for the source of the object.
If there is not at least one resource that matches each of the elements of
|
| targets | Array of strings The target arrays to replicate created snapshots to.
Only valid when |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| suffix | string The suffix of the snapshot, e.g., |
Responses
Request samples
- Payload
{- "suffix": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "owner": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "owner_destroyed": true,
- "policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "suffix": "snap1",
- "time_remaining": 0
}
]
}DELETE file-system-snapshots
Delete a file system snapshot.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH file-system-snapshots
Modify file system snapshot attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| latest_replica | boolean Used when destroying a snapshot. If not present or |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| destroyed | boolean Is the file system snapshot destroyed? If not specified, defaults to
|
object (FixedReference) A reference to the file system that owns this snapshot. If the owner is destroyed, this will be destroyed. | |
object (FixedLocationReference) A reference to the associated policy that drives the behavior of the snapshot. | |
object (FixedLocationReference) A reference to the file system that was the source of the data in this snapshot. Normally this is the same as the owner, but if the snapshot is replicated, the source is the original file system. |
Responses
Request samples
- Payload
{- "name": "string",
- "destroyed": true,
- "owner": { },
- "policy": {
- "location": { }
}, - "source": {
- "location": { }
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "owner": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "owner_destroyed": true,
- "policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "suffix": "snap1",
- "time_remaining": 0
}
]
}GET file-system-snapshots/policies
List file system snapshots mapped to snapshot scheduling policies. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}DELETE file-system-snapshots/policies
Remove snapshot scheduling policies from a file system.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET file-system-snapshots/transfer
List file system snapshot transfers from the source array to the target array. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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_or_owner_names | Array of strings A comma-separated list of resource names. Either the names of the snapshots or the owning file systems. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "completed": 0,
- "data_transferred": 0,
- "direction": "string",
- "local_snapshot": {
- "id": "string",
- "name": "string"
}, - "progress": 0,
- "remote": {
- "id": "string",
- "name": "string"
}, - "remote_snapshot": {
- "id": "string",
- "name": "string"
}, - "started": 0,
- "status": "string"
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "total": {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "completed": 0,
- "data_transferred": 0,
- "direction": "string",
- "local_snapshot": {
- "id": "string",
- "name": "string"
}, - "progress": 0,
- "remote": {
- "id": "string",
- "name": "string"
}, - "remote_snapshot": {
- "id": "string",
- "name": "string"
}, - "started": 0,
- "status": "string"
}
}DELETE file-system-snapshots/transfer
Delete file system snapshot transfers from the source array to the target array.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET fleets
Displays information about the fleets known to the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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. Only one value is supported. |
| limit | integer <int32> >= 0 Example: limit=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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "is_local": true
}
]
}POST fleets
Creates a fleet and adds the current array as its first member.
Additional arrays can be added to the fleet with POST /fleets/members
Authorizations:
query Parameters
| names | Array of strings Performs the operation on the unique resource names specified. Only one value is supported. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "is_local": true
}
]
}DELETE Fleets
Permanently delete a fleet. A fleet can only be deleted if the current array is the only array in the fleet.
Authorizations:
query Parameters
| 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. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH fleets
Rename a fleet by passing the old name in name query parameter, and the new name in the
name parameter in the request body.
Authorizations:
query Parameters
| 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. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string The new name for the resource. |
Responses
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "is_local": true
}
]
}GET fleet-key
Displays the time remaining on the fleet key. Note: fleet key itself is not displayed, since that is only available at the time of fleet key creation.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "created": 1706850977,
- "expires": 1706854577,
- "fleet_key": "CAUSJDljMGM3MGY3LWFhZDEtNDRkZC05ZDQ2LTZlOTA3YzY3Yzg1YxokOWMwYzcwZjctYWFkMS00NGRkLTlkND"
}
]
}POST fleet-key
Creates a fleet key allowing an array to be added to a fleet. This is the only time the fleet key is displayed, it cannot be retrieved subsequently. Note: Creation of a subsequent key invalidates all keys created earlier.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "created": 1706850977,
- "expires": 1706854577,
- "fleet_key": "CAUSJDljMGM3MGY3LWFhZDEtNDRkZC05ZDQ2LTZlOTA3YzY3Yzg1YxokOWMwYzcwZjctYWFkMS00NGRkLTlkND"
}
]
}GET fleet members
Displays the members in the current fleet.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "fleet": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "is_local": true
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "is_local": true
}, - "status": "string",
- "status_details": "cannot reach array"
}
]
}POST fleets
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.
Authorizations:
query Parameters
| fleet_ids | Array of strings Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID. |
| fleet_names | Array of strings Performs the operation on the unique Fleet names specified.
Enter multiple names in comma-separated format.
For example, |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Info about the members being added to fleet.
Array of objects (_fleetMemberPostMembers) Info about the members being added to fleet. |
Responses
Request samples
- Payload
{- "members": [
- {
- "key": "string",
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Response samples
- 200
{- "items": [
- {
- "fleet": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "is_local": true
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "is_local": true
}, - "status": "string",
- "status_details": "cannot reach array"
}
]
}Remove fleet members
Remove 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.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| unreachable | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Manages hardware components. List information about array hardware components that are capable of reporting their status. The display is primarily useful for diagnosing hardware-related problems.
GET hardware
List hardware slots and bays and the status of installed components.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "data_mac": "fa:16:3e:a1:c6:ce",
- "details": "Temperature too high",
- "identify_enabled": true,
- "index": 1,
- "management_mac": "24:a9:37:ca:a0:d0",
- "model": "FB-8TB",
- "part_number": "83-0139-01",
- "sensor_readings": [
- {
- "name": "string",
- "reading": 0,
- "status": "string",
- "thresholds": {
- "critical": 0,
- "non_critical": 0,
- "unrecoverable": 0
}
}
], - "serial": "S16445515B09553",
- "slot": 16,
- "speed": 10000000000,
- "status": "critical",
- "temperature": 25,
- "type": "ch"
}
]
}PATCH hardware
Controls the visual identification light of the specified hardware component.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| identify_enabled | boolean State of an LED used to visually identify the component. |
Responses
Request samples
- Payload
{- "identify_enabled": true
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "data_mac": "fa:16:3e:a1:c6:ce",
- "details": "Temperature too high",
- "identify_enabled": true,
- "index": 1,
- "management_mac": "24:a9:37:ca:a0:d0",
- "model": "FB-8TB",
- "part_number": "83-0139-01",
- "sensor_readings": [
- {
- "name": "string",
- "reading": 0,
- "status": "string",
- "thresholds": {
- "critical": 0,
- "non_critical": 0,
- "unrecoverable": 0
}
}
], - "serial": "S16445515B09553",
- "slot": 16,
- "speed": 10000000000,
- "status": "critical",
- "temperature": 25,
- "type": "ch"
}
]
}The endpoints are deprecated. Use the endpoints under Network Interfaces instead. Manages the port connector attributes on the array. Lane speeds and port count attributes can be configured.
GET hardware-connectors
The endpoint is deprecated. Use the /network-interfaces/connectors endpoint instead.
List array connection information.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "connector_type": "QSFP",
- "lane_speed": 10000000000,
- "port_count": 1,
- "port_speed": 40000000000,
- "transceiver_type": "40GBASE-LR4"
}
]
}PATCH hardware-connectors
The endpoint is deprecated. Use the /network-interfaces/connectors endpoint instead.
Modify array connection information.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| lane_speed | integer <int64> Configured speed of each lane in the connector in bits-per-second. |
| port_count | integer <int64> Configured number of ports in the connector (1/2/4 for QSFP). |
Responses
Request samples
- Payload
{- "lane_speed": 10000000000,
- "port_count": 1
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "connector_type": "QSFP",
- "lane_speed": 10000000000,
- "port_count": 1,
- "port_speed": 40000000000,
- "transceiver_type": "40GBASE-LR4"
}
]
}GET hardware-connectors/performance
The endpoint is deprecated. Use the /network-interfaces/connectors/performance
endpoint instead.
Displays network statistics, historical bandwidth, and error reporting for
all specified hardware connectors.
Authorizations:
query Parameters
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "link_aggregation_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "other_errors_per_sec": 0,
- "received_bytes_per_sec": 0,
- "received_crc_errors_per_sec": 0,
- "received_frame_errors_per_sec": 0,
- "received_packets_per_sec": 0,
- "time": 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
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "link_aggregation_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "other_errors_per_sec": 0,
- "received_bytes_per_sec": 0,
- "received_crc_errors_per_sec": 0,
- "received_frame_errors_per_sec": 0,
- "received_packets_per_sec": 0,
- "time": 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
}
]
}GET keytabs
List a Kerberos keytab file and its configuration information.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "encryption_type": "aes256-cts-hmac-sha1-96",
- "fqdn": "vip1.my-array.customerdomain.example.com",
- "kvno": 1,
- "prefix": "auth-keytabs",
- "principal": "nfs",
- "realm": "my-secure-realm.com",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "suffix": 4
}
]
}POST keytabs
Import a Kerberos keytab file from a Key Distribution Center.
Authorizations:
query Parameters
| name_prefixes | string The prefix to use for the names of all Kerberos keytab objects that are being created. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (Reference) A reference to the Active Directory configuration for the computer account whose keys will be rotated in order to create new keytabs for all of its registered service principal names. |
Responses
Request samples
- Payload
{- "source": {
- "id": "string",
- "name": "string"
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "encryption_type": "aes256-cts-hmac-sha1-96",
- "fqdn": "vip1.my-array.customerdomain.example.com",
- "kvno": 1,
- "prefix": "auth-keytabs",
- "principal": "nfs",
- "realm": "my-secure-realm.com",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "source": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "suffix": 4
}
]
}DELETE keytabs
Delete a Kerberos keytab file.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET keytabs/download
Download a Kerberos keytab file. The file can be downloaded in the native binary format or a base64 encoded format. If not specified, defaults to binary.
Authorizations:
query Parameters
| keytab_ids | Array of strings A comma-separated list of keytab 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 |
| keytab_names | Array of strings A comma-separated list of keytab names. If there is not at least one
resource that matches each of the elements, then an error is returned. This
cannot be provided together with |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
POST keytabs/upload
Upload a Kerberos keytab file to the array. The file can be uploaded in the native binary format or a base64 encoded format. If not specified, defaults to binary. The procedure to upload a file may vary depending on the type of REST client.
Authorizations:
query Parameters
| name_prefixes | string The prefix to use for the names of all Kerberos keytab objects that are being created. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: multipart/form-data
| keytab_file required | string (Keytab_file) The keytab file to upload. |
Responses
List KMIP server configurations
Displays a list of KMIP server configurations.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "uris": [
- "my1.kmipserver.com:5696",
- "tls://my2.kmipserver.com:5696"
]
}
]
}Create a KMIP server configuration
Creates a KMIP server configuration.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (Reference) CA certificate used to validate the authenticity of the configured servers. | |
object (Reference) A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers. | |
| uris | Array of strings [ 1 .. 30 ] items List of URIs for the configured KMIP servers in the format [protocol://]hostname:port. |
Responses
Request samples
- Payload
{- "ca_certificate": {
- "id": "string",
- "name": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string"
}, - "uris": [
- "my1.kmipserver.com:5696",
- "tls://my2.kmipserver.com:5696"
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "uris": [
- "my1.kmipserver.com:5696",
- "tls://my2.kmipserver.com:5696"
]
}
]
}Delete a KMIP server configuration
Deletes a KMIP server configuration. A server can only be deleted when not in use by the array.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Modify a KMIP server configuration
Modifies KMIP server properties - URI, certificate, certificate group.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (Reference) CA certificate used to validate the authenticity of the configured servers. | |
object (Reference) A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers. | |
| uris | Array of strings [ 1 .. 30 ] items List of URIs for the configured KMIP servers in the format [protocol://]hostname:port. |
Responses
Request samples
- Payload
{- "ca_certificate": {
- "id": "string",
- "name": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string"
}, - "uris": [
- "my1.kmipserver.com:5696",
- "tls://my2.kmipserver.com:5696"
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "uris": [
- "my1.kmipserver.com:5696",
- "tls://my2.kmipserver.com:5696"
]
}
]
}Displays KMIP server test results
Displays a detailed result of of KMIP server test.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
]
}Manages the creation, attributes, and deletion of holds on the array. A hold can be also applied to a path under a file system to mark the entries under the path as immutable.
List legal holds
List legal holds.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}Create a legal hold
Create a legal hold instance.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| description | string The description of the legal hold instance. |
Responses
Request samples
- Payload
{- "description": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}Delete a legal hold
Delete a legal hold instance. Deletion is not allowed if the legal hold is applied to one or more paths.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Update a legal hold
Update a legal hold instance.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| description | string The description of the legal hold instance. |
Responses
Request samples
- Payload
{- "description": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}List held entities
List entities to which a legal hold has been applied.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| file_system_ids | Array of strings A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| paths | Array of strings A comma-separated list of paths used for filtering file locks query by paths.
This may only be specified if |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "legal_hold": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "path": "string",
- "status": "string"
}
]
}Apply this legal hold to a new entity
Apply this legal hold to a new entity.
The names, file_system_names and paths query parameters are required.
The recursive flag is required when applying a hold to a directory.
Authorizations:
query Parameters
| file_system_ids | Array of strings A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| paths | Array of strings A comma-separated list of paths used for filtering file locks query by paths.
This may only be specified if |
| recursive | boolean Default: false This is a flag to set when recursively applying/releasing legal holds on entities.
By default, it is set to be false.
The |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "legal_hold": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "path": "string",
- "status": "string"
}
]
}Release this legal hold from the given entity
Release this legal hold from the given entity.
The names, file_system_names, paths and released query parameters are required.
The recursive flag is required when releasing a hold from a directory.
Authorizations:
query Parameters
| file_system_ids | Array of strings A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| paths | Array of strings A comma-separated list of paths used for filtering file locks query by paths.
This may only be specified if |
| recursive | boolean Default: false This is a flag to set when recursively applying/releasing legal holds on entities.
By default, it is set to be false.
The |
| released required | boolean Default: true This is a flag to set when releasing an attached legal hold from a path. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "legal_hold": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "path": "string",
- "status": "string"
}
]
}A life cycle rule helps manage the number of copies of a specific bucket. A lifecycle rule can be applied to a bucket with a rule indicating the retention time before it is to be deleted.
GET lifecycle-rules
Returns a list of lifecycle rules.
If names is specified, list the individual rules.
If ids is specified, bucket_names or bucket_ids is also required.
If bucket_names or bucket_ids are specified without ids,
list all the rules for the bucket.
Authorizations:
query Parameters
| allow_errors | boolean Default: false If set to |
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "abort_incomplete_multipart_uploads_after": 86400000,
- "keep_current_version_for": 86400000,
- "keep_current_version_until": 1636588800000,
- "bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "cleanup_expired_object_delete_marker": true,
- "enabled": true,
- "keep_previous_version_for": 0,
- "prefix": "string",
- "rule_id": "string"
}
]
}POST lifecycle-rules
Creates a lifecycle rule.
bucket and keep_previous_version_for are required.
If rule_id is not specified,
it will be automatically generated in the format "fbRuleIdX".
Authorizations:
query Parameters
| confirm_date | 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| abort_incomplete_multipart_uploads_after | integer <int64> Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. |
| keep_current_version_for | integer <int64> Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. |
| keep_current_version_until | integer <int64> Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day. |
object (ReferenceWritable) The bucket name for lifecycle rule creation. | |
| keep_previous_version_for | integer <int64> Time after which previous versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. |
| prefix | string Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters. |
| rule_id | string Identifier for the rule that is unique to the bucket
that it applies to.
Can have a maximum length of 255 characters.
If not specified, an id unique to the bucket will be generated in the
format |
Responses
Request samples
- Payload
{- "abort_incomplete_multipart_uploads_after": 86400000,
- "keep_current_version_for": 86400000,
- "keep_current_version_until": 1636588800000,
- "bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "keep_previous_version_for": 0,
- "prefix": "string",
- "rule_id": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "abort_incomplete_multipart_uploads_after": 86400000,
- "keep_current_version_for": 86400000,
- "keep_current_version_until": 1636588800000,
- "bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "cleanup_expired_object_delete_marker": true,
- "enabled": true,
- "keep_previous_version_for": 0,
- "prefix": "string",
- "rule_id": "string"
}
]
}DELETE lifecycle-rules
Deletes individual lifecycle rules by name or id, or deletes all rules for a bucket.
If ids is specified, bucket_names or bucket_ids is also required.
If bucket_names or bucket_ids are specified without ids,
delete all the rules for the bucket.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH lifecycle-rules
Modify an existing lifecycle rule by name or id.
If ids is specified, bucket_names or bucket_ids is also required.
Authorizations:
query Parameters
| bucket_ids | Array of strings A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| bucket_names | Array of strings A comma-separated list of bucket names.
If there is not at least one resource that matches
each of the elements of |
| confirm_date | 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 |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| abort_incomplete_multipart_uploads_after | integer <int64> Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. |
| keep_current_version_for | integer <int64> Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. |
| keep_current_version_until | integer <int64> Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day. |
| enabled | boolean If set to |
| keep_previous_version_for | integer <int64> Time after which previous versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days. |
| prefix | string Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters. |
Responses
Request samples
- Payload
{- "abort_incomplete_multipart_uploads_after": 86400000,
- "keep_current_version_for": 86400000,
- "keep_current_version_until": 1636588800000,
- "enabled": true,
- "keep_previous_version_for": 0,
- "prefix": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "abort_incomplete_multipart_uploads_after": 86400000,
- "keep_current_version_for": 86400000,
- "keep_current_version_until": 1636588800000,
- "bucket": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "cleanup_expired_object_delete_marker": true,
- "enabled": true,
- "keep_previous_version_for": 0,
- "prefix": "string",
- "rule_id": "string"
}
]
}GET link-aggregation-groups
List the status and attributes of the Ethernet ports in the configured link aggregation groups.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "lag_speed": 260000000000,
- "mac_address": "24:a9:37:11:f5:21",
- "port_speed": 10000000000,
- "ports": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "status": "healthy"
}
]
}POST link-aggregation-groups
Create a link aggregation group of Ethernet ports on the array.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (_reference) Ports associated with the LAG. |
Responses
Request samples
- Payload
{- "ports": [
- {
- "id": "string",
- "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "lag_speed": 260000000000,
- "mac_address": "24:a9:37:11:f5:21",
- "port_speed": 10000000000,
- "ports": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "status": "healthy"
}
]
}DELETE link-aggregation-groups
Remove a link aggregation group to unbind the ports.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH link-aggregation-groups
Modify link aggregation groups by adding and removing Ethernet ports.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (_reference) | |
Array of objects (_reference) | |
Array of objects (_reference) |
Responses
Request samples
- Payload
{- "add_ports": [
- {
- "id": "string",
- "name": "string"
}
], - "ports": [
- {
- "id": "string",
- "name": "string"
}
], - "remove_ports": [
- {
- "id": "string",
- "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "lag_speed": 260000000000,
- "mac_address": "24:a9:37:11:f5:21",
- "port_speed": 10000000000,
- "ports": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "status": "healthy"
}
]
}The array collects a log of command activities that can be used for analysis when the logs are sent to Pure Technical Services.
GET logs
Download a history of log events from the array to provide to Pure Technical Services for analysis.
Authorizations:
query Parameters
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
GET logs-async
List the attributes and status of preparation for a history of log events from the array to provide to Pure Technical Services for analysis.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "available_files": [
- {
- "name": "string",
- "length": 0
}
], - "end_time": 1514764800000,
- "hardware_components": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "last_request_time": 1514764800000,
- "processing": true,
- "progress": 0.99,
- "start_time": 1514764800000
}
]
}PATCH logs-async
Start the preparation for a history of log events from the array to provide to Pure Technical Services for analysis.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| end_time | integer <int64> >= 0 When the time window ends (in milliseconds since epoch). start_time and end_time determine the number of hours for which the logs are prepared for. At most 6 hours of logs can be prepared in one request. start_time and end_time are truncated to hour boundaries. |
Array of objects (_reference) All of the hardware components for which logs are being processed. | |
| start_time | integer <int64> >= 0 When the time window starts (in milliseconds since epoch). start_time and end_time determine the number of hours for which the logs are prepared for. At most 6 hours of logs can be prepared in one request. start_time and end_time are truncated to hour boundaries. |
Responses
Request samples
- Payload
{- "end_time": 1514764800000,
- "hardware_components": [
- {
- "id": "string",
- "name": "string"
}
], - "start_time": 1514764800000
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "available_files": [
- {
- "name": "string",
- "length": 0
}
], - "end_time": 1514764800000,
- "hardware_components": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "last_request_time": 1514764800000,
- "processing": true,
- "progress": 0.99,
- "start_time": 1514764800000
}
]
}GET logs-async/download
Download the files which contain a history of log events from the array to provide to Pure Technical Services for analysis.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
During a maintenance window, many alerts are suppressed that are related to connections, paths, ports, and other resources that are down during maintenance.
List maintenance window details
Displays maintenance window details, including start time, end time, and maintenance type.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "created": 0,
- "expires": 0
}
]
}Create a maintenance window
Creates a maintenance window that suppresses alerts for a specified period of time.
A maintenance window can be manually closed at any time.
The names and timeout parameters are required. Set the names parameter to array.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| timeout | integer <int32> Duration of a maintenance window measured in milliseconds.
The |
Responses
Request samples
- Payload
{- "timeout": 14400000
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "created": 0,
- "expires": 0
}
]
}Delete maintenance window
Deletes an active maintenance window before its scheduled end (expire) time.
The names parameter is required and must be set to array.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Manages the interface, network connection, and port connector attributes of the array. Lane speeds and port count connector attributes can be configured.
GET network-interfaces
List network interfaces and their attributes.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "address": "string",
- "enabled": true,
- "gateway": "string",
- "mtu": 0,
- "netmask": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "services": [
- "string"
], - "subnet": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "type": "string",
- "vlan": 0
}
]
}POST network-interfaces
Create a VIP to export data or perform replication.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| address | string The IPv4 or IPv6 address to be associated with the specified network interface. |
object (Reference) The server that is using this interface for data ingress.
Will be null if | |
| services | Array of strings Services and protocols that are enabled on the interface. |
| type | string The only valid value is |
Responses
Request samples
- Payload
{- "address": "string",
- "server": {
- "id": "string",
- "name": "string"
}, - "services": [
- "string"
], - "type": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "address": "string",
- "enabled": true,
- "gateway": "string",
- "mtu": 0,
- "netmask": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "services": [
- "string"
], - "subnet": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "type": "string",
- "vlan": 0
}
]
}DELETE network-interfaces
Remove a VIP. Once a data VIP is removed, any clients connected through the data VIP will lose their connection to the file system or bucket.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH network-interfaces
Modify the attributes of a VIP.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| address | string The IPv4 or IPv6 address to be associated with the specified network interface. |
object (Reference) The server that is using this interface for data ingress.
Will be null if | |
| services | Array of strings Services and protocols that are enabled on the interface. |
Responses
Request samples
- Payload
{- "address": "string",
- "server": {
- "id": "string",
- "name": "string"
}, - "services": [
- "string"
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "address": "string",
- "enabled": true,
- "gateway": "string",
- "mtu": 0,
- "netmask": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "services": [
- "string"
], - "subnet": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "type": "string",
- "vlan": 0
}
]
}GET network-interfaces/ping
Display network interface ping result.
Authorizations:
query Parameters
| component_name | string Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades. |
| count | integer <int32> Used by ping to specify the number of packets to send. If not specified, defaults to 1. |
| destination required | string Example: destination=www.test.com A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. |
| packet_size | integer <int32> Example: packet_size=56 Used by ping to specify the number of data bytes to be sent per packet. If not specified, defaults to 56. |
| print_latency | boolean Used by ping to specify whether or not to print the full user-to-user latency. If not specified, defaults to false. |
| resolve_hostname | boolean Used by ping and trace to specify whether or not to map IP addresses to host names. If not specified, defaults to true. |
| source | string Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "component_name": "ch1-fm1",
- "destination": "181.44.543.12",
- "details": "string",
- "source": "net1"
}
]
}GET network-interfaces/trace
Display network interface trace result.
Authorizations:
query Parameters
| component_name | string Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades. |
| destination required | string Example: destination=www.test.com A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. |
| discover_mtu | boolean Used by trace to specify whether or not to discover the MTU along the path being traced. If not specified, defaults to false. |
| fragment_packet | boolean Used by trace to specify whether or not to fragment packets. If not specified, defaults to true. |
| method | string Used by trace to specify which method to use for trace operations. Valid
values are |
| port | string Used by trace to specify a destination port. |
| resolve_hostname | boolean Used by ping and trace to specify whether or not to map IP addresses to host names. If not specified, defaults to true. |
| source | string Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "component_name": "ch1-fm1",
- "destination": "181.44.543.12",
- "details": "string",
- "source": "net1"
}
]
}GET network-interfaces/connectors
List network connector information
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "connector_type": "QSFP",
- "lane_speed": 10000000000,
- "port_count": 1,
- "port_speed": 40000000000,
- "transceiver_type": "40GBASE-LR4"
}
]
}PATCH network-interfaces/connectors
Modify network connector information.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| lane_speed | integer <int64> Configured speed of each lane in the connector in bits-per-second. |
| port_count | integer <int64> Configured number of ports in the connector (1/2/4 for QSFP). |
Responses
Request samples
- Payload
{- "lane_speed": 10000000000,
- "port_count": 1
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "connector_type": "QSFP",
- "lane_speed": 10000000000,
- "port_count": 1,
- "port_speed": 40000000000,
- "transceiver_type": "40GBASE-LR4"
}
]
}GET network connectors performance statistics
Displays network statistics, historical bandwidth, and error reporting for all specified network connectors.
Authorizations:
query Parameters
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "link_aggregation_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "other_errors_per_sec": 0,
- "received_bytes_per_sec": 0,
- "received_crc_errors_per_sec": 0,
- "received_frame_errors_per_sec": 0,
- "received_packets_per_sec": 0,
- "time": 0,
- "total_errors_per_sec": 0,
- "transmitted_bytes_per_sec": 0,
- "transmitted_carrier_errors_per_sec": 0,
- "transmitted_dropped_errors_per_sec": 0,
- "transmitted_packets_per_sec": 0,
- "flow_control_received_congestion_packets_per_sec": 0,
- "flow_control_received_discarded_packets_per_sec": 0,
- "flow_control_received_lossless_bytes_per_sec": 0,
- "flow_control_received_pause_frames_per_sec": 0,
- "flow_control_transmitted_congestion_packets_per_sec": 0,
- "flow_control_transmitted_discarded_packets_per_sec": 0,
- "flow_control_transmitted_lossless_bytes_per_sec": 0,
- "flow_control_transmitted_pause_frames_per_sec": 0,
- "rdma_received_req_cqe_errors_per_sec": 0,
- "rdma_received_sequence_errors_per_sec": 0,
- "rdma_transmitted_local_ack_timeout_errors_per_sec": 0
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "link_aggregation_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "other_errors_per_sec": 0,
- "received_bytes_per_sec": 0,
- "received_crc_errors_per_sec": 0,
- "received_frame_errors_per_sec": 0,
- "received_packets_per_sec": 0,
- "time": 0,
- "total_errors_per_sec": 0,
- "transmitted_bytes_per_sec": 0,
- "transmitted_carrier_errors_per_sec": 0,
- "transmitted_dropped_errors_per_sec": 0,
- "transmitted_packets_per_sec": 0,
- "flow_control_received_congestion_packets_per_sec": 0,
- "flow_control_received_discarded_packets_per_sec": 0,
- "flow_control_received_lossless_bytes_per_sec": 0,
- "flow_control_received_pause_frames_per_sec": 0,
- "flow_control_transmitted_congestion_packets_per_sec": 0,
- "flow_control_transmitted_discarded_packets_per_sec": 0,
- "flow_control_transmitted_lossless_bytes_per_sec": 0,
- "flow_control_transmitted_pause_frames_per_sec": 0,
- "rdma_received_req_cqe_errors_per_sec": 0,
- "rdma_received_sequence_errors_per_sec": 0,
- "rdma_transmitted_local_ack_timeout_errors_per_sec": 0
}
]
}GET global network settings for network connectors
Display the global network settings for network connectors.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "roce": {
- "default_ecn": {
- "marking_probability": 0,
- "max_ecn_marked_threshold": 0,
- "min_ecn_marked_threshold": 0
}, - "default_pfc": {
- "port_buffer": 0,
- "xoff_threshold": 0,
- "xon_threshold": 0
}, - "enabled": true,
- "network_congestion_mode": "string",
- "trust_mode": "string"
}
}
]
}GET network-interfaces/network-connection-statistics
Display network interface status
Authorizations:
query Parameters
| current_state | Array of strings The state to filter the results by. If specified, the results will only include connections which current state matches the specified states. |
| 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_host | Array of strings The local IP address to filter the results by. If specified, the results will only include connections that are either to or from the specified local host. |
| local_port | Array of integers The local port to filter the results by. If specified, the results will only include connections that are either to or from the specified local port. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| remote_host | Array of strings The remote IP address to filter the results by. If specified, the results will only include connections that are either to or from the specified remote host. |
| remote_port | Array of integers The remote port to filter the results by. If specified, the results will only include connections that are either to or from the specified remote port. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "current_state": "TIME_WAIT",
- "local": {
- "address": "168.192.0.1",
- "port": "8080"
}, - "remote": {
- "address": "168.192.0.1",
- "port": "8080"
}, - "time": 1735596861
}
]
}Manages the nodes for pNFS. These nodes are where the client will read/write to when pNFS is enabled.
GET nodes
List one or more nodes.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "capacity": 0,
- "data_addresses": [
- "string"
], - "details": "string",
- "management_address": "string",
- "raw_capacity": 0,
- "serial_number": "string",
- "status": "string",
- "unique": 0
}
], - "total": {
- "id": "string",
- "name": "string",
- "capacity": 0,
- "data_addresses": [
- "string"
], - "details": "string",
- "management_address": "string",
- "raw_capacity": 0,
- "serial_number": "string",
- "status": "string",
- "unique": 0
}
}PATCH nodes
Modify a node's attributes including its management address and serial number.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| management_address | string The control IP address of the node. A connection will be made to this address to get info on the node such as the data addresses. If a connection cannot be made to the given management address, both the POST and PATCH request modifying this field will fail. |
| serial_number | string The serial number of the node. If the given serial number does not match the serial number of the node, both the POST and PATCH request modifying this field will fail. |
Responses
Request samples
- Payload
{- "name": "string",
- "management_address": "string",
- "serial_number": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "capacity": 0,
- "data_addresses": [
- "string"
], - "details": "string",
- "management_address": "string",
- "raw_capacity": 0,
- "serial_number": "string",
- "status": "string",
- "unique": 0
}
]
}POST nodes/batch
Add one or more nodes.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| management_address | string The control IP address of the node. A connection will be made to this address to get info on the node such as the data addresses. If a connection cannot be made to the given management address, both the POST and PATCH request modifying this field will fail. |
| serial_number | string The serial number of the node. If the given serial number does not match the serial number of the node, both the POST and PATCH request modifying this field will fail. |
Responses
Request samples
- Payload
[- {
- "name": "string",
- "management_address": "string",
- "serial_number": "string"
}
]Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "capacity": 0,
- "data_addresses": [
- "string"
], - "details": "string",
- "management_address": "string",
- "raw_capacity": 0,
- "serial_number": "string",
- "status": "string",
- "unique": 0
}
]
}GET node-groups
Display all array node groups.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string"
}
]
}POST node-groups
Create one or more node groups on the array.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string"
}
]
}PATCH node-groups
Update one or more node groups on the array.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string |
Responses
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string"
}
]
}DELETE node-groups
Delete one or more node groups from the array.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET node-groups/nodes
List membership associations between node groups and nodes on the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 |
| node_group_ids | Array of strings A comma-separated list of node group ids.
If there is not at least one resource that matches each of the
elements of |
| node_group_names | Array of strings A comma-separated list of node group names.
If there is not at least one resource that matches each of the
elements of |
| node_ids | Array of strings A comma-separated list of node ids.
If there is not at least one resource that matches each of the
elements of |
| node_names | Array of strings A comma-separated list of node names.
If there is not at least one resource that matches each of the
elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST node-groups/nodes
Add one or more nodes to one or more node groups on the array.
Authorizations:
query Parameters
| node_group_ids | Array of strings A comma-separated list of node group ids.
If there is not at least one resource that matches each of the
elements of |
| node_group_names | Array of strings A comma-separated list of node group names.
If there is not at least one resource that matches each of the
elements of |
| node_ids | Array of strings A comma-separated list of node ids.
If there is not at least one resource that matches each of the
elements of |
| node_names | Array of strings A comma-separated list of node names.
If there is not at least one resource that matches each of the
elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE node-groups/nodes
Remove one or more nodes from one or more groups.
Authorizations:
query Parameters
| node_group_ids | Array of strings A comma-separated list of node group ids.
If there is not at least one resource that matches each of the
elements of |
| node_group_names | Array of strings A comma-separated list of node group names.
If there is not at least one resource that matches each of the
elements of |
| node_ids | Array of strings A comma-separated list of node ids.
If there is not at least one resource that matches each of the
elements of |
| node_names | Array of strings A comma-separated list of node names.
If there is not at least one resource that matches each of the
elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET node-groups/uses
List how node groups are being used and by what.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "use": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Manages object store access keys. A maximum of two sets of keys can be created for each object store user. A set of keys consists of an access key ID and Secret Access Key.
GET object-store-access-keys
List object store access keys.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "enabled": true,
- "secret_access_key": "string",
- "user": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST object-store-access-keys
Create or import object store access keys.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names to import.
To import a set of credentials, this field must be specified
with the |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| secret_access_key | string The secret access key to import from another FlashBlade.
To import a set of credentials, this field must be specified
with the |
object An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the environment, like a host or a server. |
Responses
Request samples
- Payload
{- "secret_access_key": "string",
- "user": {
- "id": "string",
- "name": "string"
}
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "enabled": true,
- "secret_access_key": "string",
- "user": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE object-store-access-keys
Delete an object store access key. Once an access key has been deleted, it cannot be recovered.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH object-store-access-keys
Enable or disable object store access keys.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| enabled | boolean Is the access key enabled? If not specified, defaults to |
object (FixedReference) Reference of the associated user. |
Responses
Request samples
- Payload
{- "enabled": true,
- "user": { }
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "enabled": true,
- "secret_access_key": "string",
- "user": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Manages object store accounts. Accounts contain buckets and users. Accounts must be created before an object store user or buckets can be created.
GET object-store-accounts
List object store accounts and their attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket_defaults": {
- "hard_limit_enabled": true,
- "quota_limit": 0
}, - "created": 0,
- "hard_limit_enabled": true,
- "object_count": 0,
- "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "quota_limit": 0,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}
}
], - "total": {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket_defaults": {
- "hard_limit_enabled": true,
- "quota_limit": 0
}, - "created": 0,
- "hard_limit_enabled": true,
- "object_count": 0,
- "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "quota_limit": 0,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}
}
}POST object-store-accounts
Create an object store account.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (BucketDefaults) Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields. | |
| hard_limit_enabled | boolean If set to |
| quota_limit | string The effective quota limit to be applied against the size of the account, displayed in bytes.
If set to an empty string ( |
Responses
Request samples
- Payload
{- "bucket_defaults": {
- "hard_limit_enabled": true,
- "quota_limit": "string"
}, - "hard_limit_enabled": true,
- "quota_limit": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket_defaults": {
- "hard_limit_enabled": true,
- "quota_limit": 0
}, - "created": 0,
- "hard_limit_enabled": true,
- "object_count": 0,
- "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "quota_limit": 0,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}
}
]
}DELETE object-store-accounts
Delete an object store account.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH object-store-accounts
Modify object store account attributes such as quota limit and bucket defaults.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| ignore_usage | boolean Allow update operations that lead to a |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (BucketDefaults) Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields. | |
| hard_limit_enabled | boolean If set to |
object (_publicAccessConfig) Configuration settings related to public access. | |
| quota_limit | string The effective quota limit to be applied against the size of the account, displayed in bytes.
If set to an empty string ( |
Responses
Request samples
- Payload
{- "bucket_defaults": {
- "hard_limit_enabled": true,
- "quota_limit": "string"
}, - "hard_limit_enabled": true,
- "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "quota_limit": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "bucket_defaults": {
- "hard_limit_enabled": true,
- "quota_limit": 0
}, - "created": 0,
- "hard_limit_enabled": true,
- "object_count": 0,
- "public_access_config": {
- "block_new_public_policies": true,
- "block_public_access": true
}, - "quota_limit": 0,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}
}
]
}Manages remote credentials for remote objects. Remote credentials contain access information that can be reused for multiple objects.
GET object-store-remote-credentials
List object store remote credentials used by bucket replica links to access buckets on remote arrays or targets.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "access_key_id": "PSFBIKZFCAAAKOEJ",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "secret_access_key": "0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD"
}
]
}POST object-store-remote-credentials
Create object store remote credentials to set up bucket replicat links to a remote array or target.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| access_key_id | string Access Key ID to be used when connecting to a remote object store. |
| secret_access_key | string Secret Access Key to be used when connecting to a remote object store. |
Responses
Request samples
- Payload
{- "access_key_id": "PSFBIKZFCAAAKOEJ",
- "secret_access_key": "0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "access_key_id": "PSFBIKZFCAAAKOEJ",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "secret_access_key": "0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD"
}
]
}DELETE object-store-remote-credentials
Delete object store remote credentials.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH object-store-remote-credentials
Rename and/or change the access key/secret key pair for object store remote credentials.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| access_key_id | string Access Key ID to be used when connecting to a remote object store. |
object (FixedReference) Reference to the associated remote, which can either be a | |
| secret_access_key | string Secret Access Key to be used when connecting to a remote object store. |
Responses
Request samples
- Payload
{- "name": "string",
- "access_key_id": "PSFBIKZFCAAAKOEJ",
- "remote": { },
- "secret_access_key": "0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "access_key_id": "PSFBIKZFCAAAKOEJ",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "secret_access_key": "0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD"
}
]
}Manages the roles assumable by external federated entity. Each role is assigned a trust policy that determines which identity provider authorizes the entities and how.
GET object-store-roles
List object store roles and their attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "max_session_duration": 0,
- "prn": "prn::iam:array-id/local:obj-account-id/123456789101112:role/myrole",
- "trusted_entities": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}POST object-store-roles
Create new object store roles.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| max_session_duration | integer Maximum session duration in milliseconds. If not provided when creating the role, defaults to 1h, minimum is 1h, maximum is 12h. |
Responses
Request samples
- Payload
{- "max_session_duration": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "max_session_duration": 0,
- "prn": "prn::iam:array-id/local:obj-account-id/123456789101112:role/myrole",
- "trusted_entities": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}DELETE object-store-roles
Delete existing object store roles.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH object-store-roles
Modify existing object store roles.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (FixedReference) Reference of the associated account. | |
| max_session_duration | integer The maximum session duration for the role in milliseconds |
Responses
Request samples
- Payload
{- "account": { },
- "max_session_duration": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "max_session_duration": 0,
- "prn": "prn::iam:array-id/local:obj-account-id/123456789101112:role/myrole",
- "trusted_entities": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}GET object-store-roles/object-store-access-policies
List object store roles and their access policies.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST object-store-roles/object-store-access-policies
Grant access policies to an object store role.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE object-store-roles/object-store-access-policies
Revoke an object store role's access policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET object-store-roles/object-store-trust-policies
List object store roles and their trust policies.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| role_ids | Array of strings A comma-separated list of object store role IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_names | Array of strings A comma-separated list of object store role names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": [
- {
- "name": "string",
- "index": 0,
- "actions": [
- "sts:AssumeRoleWithSAML"
], - "conditions": [
- {
- "key": "saml:sub",
- "operator": "StringEquals",
- "values": [
- "something",
- "anything"
]
}
], - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "principals": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}
]
}GET object-store-roles/object-store-trust-policies/download
Download object store roles and their trust policies in native AWS format.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| role_ids | Array of strings A comma-separated list of object store role IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_names | Array of strings A comma-separated list of object store role names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
"{\n \"Version\": \"2012-10-17\",\n \"Statement\": [{\n \"Action\": \"sts:AssumeRoleWithSAML\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Federated\": \"arn:aws:iam:::saml-provider/example\"\n },\n \"Condition\": {\n \"StringEquals\": {\n \"saml:aud\": \"engineers\"\n }\n }\n }]\n}"PATCH object-store-roles/object-store-trust-policies/upload
Upload object store roles and their trust policies in native AWS format.
Authorizations:
query Parameters
| 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, |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| role_ids | Array of strings A comma-separated list of object store role IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_names | Array of strings A comma-separated list of object store role names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
The trust policy document to upload.
Trust policy document in the AWS IAM format.
Responses
Request samples
- Payload
"{\n \"Version\": \"2012-10-17\",\n \"Statement\": [{\n \"Action\": \"sts:AssumeRoleWithSAML\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Federated\": \"arn:aws:iam:::saml-provider/example\"\n },\n \"Condition\": {\n \"StringEquals\": {\n \"saml:aud\": \"engineers\"\n }\n }\n }]\n}"Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "role": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": [
- {
- "name": "string",
- "index": 0,
- "actions": [
- "sts:AssumeRoleWithSAML"
], - "conditions": [
- {
- "key": "saml:sub",
- "operator": "StringEquals",
- "values": [
- "something",
- "anything"
]
}
], - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "principals": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}
]
}GET object-store-roles/object-store-trust-policies/rules
List trust policy rules and their attributes.
Authorizations:
query Parameters
| 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. |
| indices | Array of integers A comma-separated list of resource indices.
If there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_names | Array of strings A comma-separated list of policy names. |
| role_ids | Array of strings A comma-separated list of object store role IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_names | Array of strings A comma-separated list of object store role names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "name": "string",
- "index": 0,
- "actions": [
- "sts:AssumeRoleWithSAML"
], - "conditions": [
- {
- "key": "saml:sub",
- "operator": "StringEquals",
- "values": [
- "something",
- "anything"
]
}
], - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "principals": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST object-store-roles/object-store-trust-policies/rules
Create a new trust policy rule.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| role_ids | Array of strings A comma-separated list of object store role IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_names | Array of strings A comma-separated list of object store role names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| actions | Array of strings The list of role-assumption actions granted by this rule to the respective role.
Currently we support |
Array of objects (_trustPolicyRuleCondition) Conditions used to limit the scope which this rule applies to. | |
object (FixedReference) The policy to which this rule belongs. | |
Array of objects (_referenceWritable) List of Identity Providers |
Responses
Request samples
- Payload
{- "actions": [
- "sts:AssumeRoleWithSAML"
], - "conditions": [
- {
- "key": "saml:sub",
- "operator": "StringEquals",
- "values": [
- "something",
- "anything"
]
}
], - "policy": { },
- "principals": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "index": 0,
- "actions": [
- "sts:AssumeRoleWithSAML"
], - "conditions": [
- {
- "key": "saml:sub",
- "operator": "StringEquals",
- "values": [
- "something",
- "anything"
]
}
], - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "principals": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE object-store-roles/object-store-trust-policies/rules
Delete one or more trust policy rules.
Authorizations:
query Parameters
| 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 |
| indices | Array of integers A comma-separated list of resource indices.
If there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| role_ids | Array of strings A comma-separated list of object store role IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_names | Array of strings A comma-separated list of object store role names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH object-store-roles/object-store-trust-policies/rules
Modify a trust policy rule's attributes.
Authorizations:
query Parameters
| 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 |
| indices | Array of integers A comma-separated list of resource indices.
If there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| role_ids | Array of strings A comma-separated list of object store role IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| role_names | Array of strings A comma-separated list of object store role names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| actions | Array of strings The list of role-assumption actions granted by this rule to the respective role.
Currently we support |
Array of objects (_trustPolicyRuleCondition) Conditions used to limit the scope which this rule applies to. | |
object (FixedReference) The policy to which this rule belongs. | |
Array of objects (_referenceWritable) List of Identity Providers |
Responses
Request samples
- Payload
{- "actions": [
- "sts:AssumeRoleWithSAML"
], - "conditions": [
- {
- "key": "saml:sub",
- "operator": "StringEquals",
- "values": [
- "something",
- "anything"
]
}
], - "policy": { },
- "principals": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "index": 0,
- "actions": [
- "sts:AssumeRoleWithSAML"
], - "conditions": [
- {
- "key": "saml:sub",
- "operator": "StringEquals",
- "values": [
- "something",
- "anything"
]
}
], - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "principals": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Manages the object store users attributes. Each user is assigned to an object store account and given an access key.
GET object-store-users
List object store users and their attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "access_keys": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0
}
]
}POST object-store-users
Create object store users to administer object storage for an object store account.
Authorizations:
query Parameters
| 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 |
| full_access | boolean If set to |
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "access_keys": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0
}
]
}DELETE object-store-users
Delete an object store user.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET object-store-users/object-store-access-policies
List object store users and their access policies.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST object-store-users/object-store-access-policies
Grant access policies to an object store user.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE object-store-users/object-store-access-policies
Revoke an object store user’s access policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Manages virtual host-style addressing for S3 requests to read or write an object within a bucket on the array.
GET object-store-virtual-hosts
List object store virtual hosts.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "s3.myarray.com",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST object-store-virtual-hosts
Create an object store virtual host. An example of a hostname is buckethost.example.com. A hostname cannot exceed 255 characters in length, it cannot be an IP address, only 10 hostnames are supported, supersets or subsets of existing hostnames with the same root are not allowed. The default hostname is s3.amazonaws.com and it cannot be deleted.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "s3.myarray.com",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE object-store-virtual-hosts
Delete an object store virtual host.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
OIDC SSO allows customers to configure settings of OIDC service provider and identity provider. It provides a multi-factor authentication (MFA) mechanism for customers to log in to FlashBlade.
List OIDC SSO configurations
Displays the OIDC SSO configuration settings in the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "idp": {
- "provider_url": "string",
- "provider_url_ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "provider_url_ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "prn": "prn::iam:array-id/local::oidc-provider/myidp",
- "services": [
- "string"
]
}
]
}Create OIDC SSO configuration
Create OIDC SSO configuration.
Authorizations:
query Parameters
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| enabled | boolean If set to |
object (_oidcSsoPostIdp) Identity Provider | |
| services | Array of strings Services that the OIDC SSO authentication is used for.
Valid values: |
Responses
Request samples
- Payload
{- "enabled": true,
- "idp": {
- "provider_url": "string",
- "provider_url_ca_certificate": {
- "id": "string",
- "name": "string"
}, - "provider_url_ca_certificate_group": {
- "id": "string",
- "name": "string"
}
}, - "services": [
- "string"
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "idp": {
- "provider_url": "string",
- "provider_url_ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "provider_url_ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "prn": "prn::iam:array-id/local::oidc-provider/myidp",
- "services": [
- "string"
]
}
]
}Delete OIDC SSO configurations
Delete OIDC SSO configurations.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Modify OIDC SSO configuration
Modify one or more attributes of OIDC SSO configuration.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| enabled | boolean If set to |
object (_oidcSsoPostIdp) Identity Provider | |
| services | Array of strings Services that the OIDC SSO authentication is used for.
Valid values: |
| name | string A new name for the provider |
Responses
Request samples
- Payload
{- "enabled": true,
- "idp": {
- "provider_url": "string",
- "provider_url_ca_certificate": {
- "id": "string",
- "name": "string"
}, - "provider_url_ca_certificate_group": {
- "id": "string",
- "name": "string"
}
}, - "services": [
- "string"
], - "name": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "idp": {
- "provider_url": "string",
- "provider_url_ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "provider_url_ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "prn": "prn::iam:array-id/local::oidc-provider/myidp",
- "services": [
- "string"
]
}
]
}GET policies-all
List all policies of all types.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}GET policies-all/members
List policies (of all types) mapped to other entities (file systems, snapshots, file system replica links, and object store users). Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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 |
| local_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| member_types | Array of strings A comma-separated list of member types. Valid values are |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| remote_file_system_ids | Array of strings A comma-separated list of remote file system IDs. If 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_file_system_names | Array of strings A comma-separated list of remote file system names. If there is not at
least one resource that matches each of the elements, then an error is
returned. This cannot be provided together with the |
| remote_ids | 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 Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "link": {
- "local_file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote": {
- "id": "string",
- "name": "string"
}, - "remote_file_system": {
- "id": "string",
- "name": "string"
}
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}Manages audit policies for filesystems. These policies are composed of log target rules which contain the destination for audit logs.
GET audit-file-systems-policies
Displays a list of audit policies for file systems.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "control_type": "string",
- "log_targets": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "rules": [
- {
- "id": "string",
- "name": "string",
- "op_status": "success",
- "operations": [
- "read",
- "write",
- "getattr"
]
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST audit-file-systems-policies
Create a new audit policy for file systems.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
| control_type | string Specifies the evaluation mode for auditing in this policy. Valid values are "policy", "sacl". If not specified, the default value is "sacl". |
Array of objects (_reference) List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets. | |
Array of objects (AuditFileSystemsPolicyRuleInPolicy) <= 2 items All of the rules that are part of this policy. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "control_type": "string",
- "log_targets": [
- {
- "id": "string",
- "name": "string"
}
], - "rules": [
- {
- "op_status": "success",
- "operations": [
- "read",
- "write",
- "getattr"
]
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "control_type": "string",
- "log_targets": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "rules": [
- {
- "id": "string",
- "name": "string",
- "op_status": "success",
- "operations": [
- "read",
- "write",
- "getattr"
]
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE audit-file-systems-policies
Delete one or more audit policies.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH audit-file-systems-policies
Modify an existing audit policy's attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
Array of objects (_reference) List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets. | |
Array of objects (AuditFileSystemsPolicyRuleInPolicy) <= 2 items All of the rules that are part of this policy. | |
Array of objects (_reference) The log targets which will be added to the existing | |
Array of objects (_reference) The log targets which will be removed from the existing |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "log_targets": [
- {
- "id": "string",
- "name": "string"
}
], - "rules": [
- {
- "op_status": "success",
- "operations": [
- "read",
- "write",
- "getattr"
]
}
], - "add_log_targets": [
- {
- "id": "string",
- "name": "string"
}
], - "remove_log_targets": [
- {
- "id": "string",
- "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "control_type": "string",
- "log_targets": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "rules": [
- {
- "id": "string",
- "name": "string",
- "op_status": "success",
- "operations": [
- "read",
- "write",
- "getattr"
]
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}GET audit-file-systems-policies/members
List file systems mapped to a audit policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST audit-file-systems-policies/members
Map a file system to a audit policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE audit-file-systems-policies/members
Remove the audit policy mapped to a file system.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET audit-file-systems-policy-operations
List of valid strings for audit policy rules for file systems.
Each string is either a valid operation or our custom group of operations (ReadOnly, WriteOnly).
Each of the operations, when included in a rule, will audit the operation on the file system.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "description": "Configures auditing on read, write of files in a file system."
}
]
}Manages management access policies. These policies are composed of rules which govern an administrative user's permissions when managing resources.
GET admins/management-access-policies
List management access policies mapped to admins.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST admins/management-access-policies
Map an admin to a management access policy.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE admins/management-access-policies
Remove the mapping of an admin to a management access policies.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET directory-services/roles/management-access-policies
List management access policies mapped to directory service group mappings.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST directory-services/roles/management-access-policies
Map a directory service group to a management access policy.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE directory-services/roles/management-access-policies
Remove the mapping of a directory service group to a management access policies.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET management-access-policies
Displays a list of management access policies, which can be assigned to admins, API clients, or directory-service roles.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "aggregation_strategy": "string",
- "rules": [
- {
- "id": "string",
- "name": "string",
- "role": {
- "name": "string"
}, - "scope": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "index": 0
}
]
}
]
}POST management-access-policies
Create a new management access policy, which can be assigned to admins, API clients, or directory-service roles.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
| aggregation_strategy | string When this is set to |
Array of objects (ManagementAccessPolicyRuleInPolicy) <= 200 items All of the rules that are part of this policy. The order is the evaluation order. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "aggregation_strategy": "string",
- "rules": [
- {
- "role": {
- "name": "string"
}, - "scope": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "aggregation_strategy": "string",
- "rules": [
- {
- "id": "string",
- "name": "string",
- "role": {
- "name": "string"
}, - "scope": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "index": 0
}
]
}
]
}DELETE management-access-policies
Delete one or more management access policies.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH management-access-policies
Modify an existing management access policy, which can be assigned to admins, API clients, or directory-service roles.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
| aggregation_strategy | string When this is set to |
Array of objects (ManagementAccessPolicyRuleInPolicy) <= 200 items All of the rules that are part of this policy. The order is the evaluation order. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "aggregation_strategy": "string",
- "rules": [
- {
- "role": {
- "name": "string"
}, - "scope": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "aggregation_strategy": "string",
- "rules": [
- {
- "id": "string",
- "name": "string",
- "role": {
- "name": "string"
}, - "scope": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "index": 0
}
]
}
]
}GET management-access-policies/admins
List management access policies mapped to admins.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST management-access-policies/admins
Map an admin to a management access policy.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE management-access-policies/admins
Remove the mapping of an admin to a management access policies.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET management-access-policies/directory-services/roles
List management access policies mapped to directory service group mappings.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST management-access-policies/directory-services/roles
Map a directory service group to a management access policy.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE management-access-policies/directory-services/roles
Remove the mapping of a directory service group to a management access policies.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET management-access-policies/members
List the members mapped to management access policies.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Manages network access policies. These policies are composed of rules which govern a client's ability to access different product interfaces.
GET network-access-policies
Displays a list of network access policies.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "rules": [
- {
- "id": "string",
- "name": "string",
- "client": "1.2.3.4",
- "effect": "string",
- "interfaces": [
- "string"
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0
}
]
}
]
}PATCH network-access-policies
Modify an existing network access policy's attributes.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
Array of objects (NetworkAccessPolicyRuleInPolicy) <= 200 items All of the rules that are part of this policy. The order is the evaluation order. If a client does not match any rule in the policy for the interface that they are attempting to access, the default is to deny access. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "rules": [
- {
- "client": "1.2.3.4",
- "effect": "string",
- "interfaces": [
- "string"
], - "policy": { }
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "rules": [
- {
- "id": "string",
- "name": "string",
- "client": "1.2.3.4",
- "effect": "string",
- "interfaces": [
- "string"
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0
}
]
}
]
}GET network-access-policies/members
List network access policies mapped to different configurations on the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}GET network-access-policies/rules
Displays a list of network access policy rules.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "client": "1.2.3.4",
- "effect": "string",
- "interfaces": [
- "string"
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0
}
]
}POST network-access-policies/rules
Create a new network access policy rule.
Either policy_ids or policy_names parameter is required.
Authorizations:
query Parameters
| before_rule_id | string The id of the rule to insert or move a rule before.
This cannot be provided together with the |
| before_rule_name | string The name of the rule to insert or move a rule before.
This cannot be provided together with the |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| client | string Specifies the clients that will be permitted or denied access to the interface.
Accepted notations include a single IP address, subnet in CIDR notation,
or all clients (specified as |
| effect | string If set to |
| interfaces | Array of strings <= 5 items Specifies which product interfaces this rule applies to, whether it is
permitting or denying access. Valid values include |
| index | integer <int32> The index within the policy. The |
Responses
Request samples
- Payload
{- "client": "1.2.3.4",
- "effect": "string",
- "interfaces": [
- "string"
], - "index": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "client": "1.2.3.4",
- "effect": "string",
- "interfaces": [
- "string"
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0
}
]
}DELETE network-access-policies/rules
Delete one or more network access policy rules.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH network-access-policies/rules
Modify an existing network access policy rule.
Authorizations:
query Parameters
| before_rule_id | string The id of the rule to insert or move a rule before.
This cannot be provided together with the |
| before_rule_name | string The name of the rule to insert or move a rule before.
This cannot be provided together with the |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| client | string Specifies the clients that will be permitted or denied access to the interface.
Accepted notations include a single IP address, subnet in CIDR notation,
or all clients (specified as |
| effect | string If set to |
| interfaces | Array of strings <= 5 items Specifies which product interfaces this rule applies to, whether it is
permitting or denying access. Valid values include |
object (FixedReference) The policy to which this rule belongs. | |
| index | integer <int32> The index within the policy. The |
Responses
Request samples
- Payload
{- "client": "1.2.3.4",
- "effect": "string",
- "interfaces": [
- "string"
], - "policy": { },
- "index": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "client": "1.2.3.4",
- "effect": "string",
- "interfaces": [
- "string"
], - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0
}
]
}Manages NFS export policies. These policies are composed of rules which govern a client's ability to access the exported filesystem.
GET nfs-export-policies
Displays a list of NFS export policies.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": [
- {
- "id": "string",
- "name": "string",
- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
], - "index": 0
}
]
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST nfs-export-policies
Create a new NFS export policy.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
Array of objects (NfsExportPolicyRuleInPolicy) <= 200 items All of the rules that are part of this policy. The order is the evaluation order. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "rules": [
- {
- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": { },
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
]
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": [
- {
- "id": "string",
- "name": "string",
- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
], - "index": 0
}
]
}
]
}DELETE nfs-export-policies
Delete one or more NFS export policies.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH nfs-export-policies
Modify an existing NFS export policy's attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
Array of objects (NfsExportPolicyRuleInPolicy) <= 200 items All of the rules that are part of this policy. The order is the evaluation order. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "rules": [
- {
- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": { },
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
]
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "rules": [
- {
- "id": "string",
- "name": "string",
- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
], - "index": 0
}
]
}
]
}GET nfs-export-policies/rules
Displays a list of NFS export policy rules. The default sort is by policy name, then index.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
], - "index": 0,
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST nfs-export-policies/rules
Add a NFS export policy rule. Rules are ordered in three groups; ip addresses, other and *.
The new rule will be added at the end of the appropriate group if neither
before_rule_id and before_rule_name are specified. Rules can only be inserted into the
appropriate group.
Either policy_ids or policy_names parameter is required.
Authorizations:
query Parameters
| before_rule_id | string The id of the rule to insert or move a rule before.
This cannot be provided together with the |
| before_rule_name | string The name of the rule to insert or move a rule before.
This cannot be provided together with the |
| 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 |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| access | string Specifies access control for the export. Valid values are |
| anongid | string Any user whose GID is affected by an |
| anonuid | string Any user whose UID is affected by an |
| atime | boolean If |
| client | string Specifies the clients that will be permitted to access the export.
Accepted notation is a single IP address, subnet in CIDR notation, netgroup,
hostname (see RFC-1123 part 2.1), fully qualified domain name
(see RFC-1123 part 2.1, RFC 2181 part 11), wildcards with fully qualified domain name
or hostname, or anonymous ( |
| fileid_32bit | boolean Whether the file id is 32 bits or not. Defaults to |
| permission | string Specifies which read-write client access permissions are allowed for the export.
Valid values are |
object (FixedReference) The policy to which this rule belongs. | |
| required_transport_security | string Specifies the minimum transport security required for clients to access the export.
If |
| secure | boolean If |
| security | Array of strings The security flavors to use for accessing files on this mount point. If the server does not
support the requested flavor, the mount operation fails.
If |
| index | integer <int32> The index within the policy. The |
Responses
Request samples
- Payload
{- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": { },
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
], - "index": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
], - "index": 0,
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE nfs-export-policies/rules
Delete one or more NFS export policy rules.
One of the following is required: ids or names.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH nfs-export-policies/rules
Modify an existing NFS export policy rule.
If before_rule_id or before_rule_name are specified, the rule will be moved before that
rule. Rules are ordered in three groups; ip addresses, other and * and can only be moved
within the appropriate group.
One of the following is required: ids or names.
Authorizations:
query Parameters
| before_rule_id | string The id of the rule to insert or move a rule before.
This cannot be provided together with the |
| before_rule_name | string The name of the rule to insert or move a rule before.
This cannot be provided together with the |
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| access | string Specifies access control for the export. Valid values are |
| anongid | string Any user whose GID is affected by an |
| anonuid | string Any user whose UID is affected by an |
| atime | boolean If |
| client | string Specifies the clients that will be permitted to access the export.
Accepted notation is a single IP address, subnet in CIDR notation, netgroup,
hostname (see RFC-1123 part 2.1), fully qualified domain name
(see RFC-1123 part 2.1, RFC 2181 part 11), wildcards with fully qualified domain name
or hostname, or anonymous ( |
| fileid_32bit | boolean Whether the file id is 32 bits or not. Defaults to |
| permission | string Specifies which read-write client access permissions are allowed for the export.
Valid values are |
object (FixedReference) The policy to which this rule belongs. | |
| required_transport_security | string Specifies the minimum transport security required for clients to access the export.
If |
| secure | boolean If |
| security | Array of strings The security flavors to use for accessing files on this mount point. If the server does not
support the requested flavor, the mount operation fails.
If |
| index | integer <int32> The index within the policy. The |
Responses
Request samples
- Payload
{- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": { },
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
], - "index": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "access": "string",
- "anongid": "65530",
- "anonuid": "65530",
- "atime": true,
- "client": "string",
- "fileid_32bit": true,
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "required_transport_security": "tls",
- "secure": true,
- "security": [
- "sys"
], - "index": 0,
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Manages access policies for object store users. Administrators can assign policies to users for managing buckets and objects.
GET object-store-access-policies
List access policies and their attributes.
Authorizations:
query Parameters
| 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 |
| exclude_rules | boolean If true, the rules field in each policy will be null.
If false, each returned policy will include its list of rules in the response.
If not specified, defaults to |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "arn": "arn:aws:iam::myaccount:policy/mypolicy",
- "created": 0,
- "description": "This policy allows users to list objects in production buckets.",
- "rules": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
]
}
], - "updated": 0
}
]
}POST object-store-access-policies
Create a new access policy.
Authorizations:
query Parameters
| 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 |
| enforce_action_restrictions | boolean Certain combinations of actions and other rule elements are inherently ignored
if specified together in a rule.
If set to |
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (PolicyRuleObjectAccessBulkManage) | |
| description | string A description of the policy, optionally specified when the policy is created. Cannot be modified for an existing policy. |
Responses
Request samples
- Payload
{- "rules": [
- {
- "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
], - "name": "string"
}
], - "description": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "arn": "arn:aws:iam::myaccount:policy/mypolicy",
- "created": 0,
- "description": "This policy allows users to list objects in production buckets.",
- "rules": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
]
}
], - "updated": 0
}
]
}DELETE object-store-access-policies
Delete one or more access policies.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH object-store-access-policies
Modify the rules of an object store access policy.
Authorizations:
query Parameters
| 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 |
| enforce_action_restrictions | boolean Certain combinations of actions and other rule elements are inherently ignored
if specified together in a rule.
If set to |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (PolicyRuleObjectAccessBulkManage) |
Responses
Request samples
- Payload
{- "rules": [
- {
- "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
], - "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "account": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "arn": "arn:aws:iam::myaccount:policy/mypolicy",
- "created": 0,
- "description": "This policy allows users to list objects in production buckets.",
- "rules": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
]
}
], - "updated": 0
}
]
}GET object-store-access-policies/object-store-roles
List object store roles and their access policies.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST object-store-access-policies/object-store-roles
Grant access policies to an object store role.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE object-store-access-policies/object-store-roles
Revoke an object store role's access policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET object-store-access-policies/object-store-users
List object store users and their access policies.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST object-store-access-policies/object-store-users
Grant access policies to an object store user.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE object-store-access-policies/object-store-users
Revokes an object store user's access policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET object-store-access-policies-rules
List access policy rules and their attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
]
}
]
}POST object-store-access-policies-rules
Create a new access policy rule.
Authorizations:
query Parameters
| 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 |
| enforce_action_restrictions | boolean Certain combinations of actions and other rule elements are inherently ignored
if specified together in a rule.
If set to |
| names required | Array of strings A comma-separated list of resource names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| actions | Array of strings The list of actions granted by this rule. Each included action may
restrict other properties of the rule.
Supported actions are returned by the
|
object (PolicyRuleObjectAccessCondition) Conditions used to limit the scope which this rule applies to. | |
| effect | string Effect of this rule.
When |
| resources | Array of strings The list of resources which this rule applies to. Each resource can include a bucket component, optionally followed by an object component. The choice of which components a resource can include is dictated by which actions are included in the rule. For further details, see the Object Store Access Policy Actions section of the User Guide. |
Responses
Request samples
- Payload
{- "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
]
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
]
}
]
}DELETE object-store-access-policies-rules
Delete one or more access policy rules.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH object-store-access-policies-rules
Modify an access policy rule's attributes.
Authorizations:
query Parameters
| 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 |
| enforce_action_restrictions | boolean Certain combinations of actions and other rule elements are inherently ignored
if specified together in a rule.
If set to |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| actions | Array of strings The list of actions granted by this rule. Each included action may
restrict other properties of the rule.
Supported actions are returned by the
|
object (PolicyRuleObjectAccessCondition) Conditions used to limit the scope which this rule applies to. | |
| effect | string Effect of this rule.
When |
| resources | Array of strings The list of resources which this rule applies to. Each resource can include a bucket component, optionally followed by an object component. The choice of which components a resource can include is dictated by which actions are included in the rule. For further details, see the Object Store Access Policy Actions section of the User Guide. |
Responses
Request samples
- Payload
{- "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
]
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "actions": [
- "s3:CreateBucket",
- "s3:PutObject"
], - "conditions": {
- "s3_delimiters": [
- "/"
], - "s3_prefixes": [
- "home/"
], - "source_ips": [
- "1.2.3.4",
- "5.6.7.0/24",
- "2001:DB8:1234:5678::/64"
]
}, - "effect": "allow",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "resources": [
- "*",
- "mybucket",
- "mybucket*",
- "mybucket*/myobject*"
]
}
]
}GET object-store-access-policy-actions
List valid actions for access policy rules. Each action is either a valid
AWS S3 action (prefixed by s3:) or our special wildcard action (s3:*).
Each action, when included in a rule, may restrict which other properties
may be set for that rule.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
], - "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "description": "Grants permission to create a new bucket."
}
]
}Manages password policies. These policies define requirements for user passwords complexity and login attempts.
List password policies
Displays a list of password policies.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "enforce_dictionary_check": true,
- "enforce_username_check": true,
- "lockout_duration": 3600000,
- "max_login_attempts": 10,
- "max_password_age": 86400000,
- "min_character_groups": 3,
- "min_characters_per_group": 1,
- "min_password_age": 86400000,
- "min_password_length": 1,
- "password_history": 5
}
]
}Modify password policies
Modifies one or more password policies. To enable a policy, set enabled=true.
To disable a policy, set enabled=false.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
| enforce_dictionary_check | boolean If |
| enforce_username_check | boolean If |
| lockout_duration | integer <int64> [ 0 .. 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> [ 0 .. 100 ] Maximum number of failed login attempts allowed before the user is locked out. |
| max_password_age | integer <int64> [ 0 .. 8639913600000 ] The maximum age of password before password change is required. Ranges from 1 day to 99999 days with 1 hour precision. 0ms value means password expiration is disabled. Maximum age is always greater than the minimum password age. |
| min_character_groups | integer <int32> [ 0 .. 4 ] The minimum number of character groups ([a-z], [A-Z], [0-9], other) required to be present in a password. |
| min_characters_per_group | integer <int32> >= 0 The minimum number of characters per group to count the group as present. |
| min_password_age | integer <int64> [ 0 .. 604800000 ] The minimum age, in milliseconds, of password before password change is allowed. Ranges from 0 ms to 7 days with precision to 1 hour. |
| min_password_length | integer <int32> [ 0 .. 100 ] Minimum password length. If not specified, defaults to 1. |
| password_history | integer <int32> [ 0 .. 64 ] The number of passwords tracked to prevent reuse of passwords. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "enforce_dictionary_check": true,
- "enforce_username_check": true,
- "lockout_duration": 3600000,
- "max_login_attempts": 10,
- "max_password_age": 86400000,
- "min_character_groups": 3,
- "min_characters_per_group": 1,
- "min_password_age": 86400000,
- "min_password_length": 1,
- "password_history": 5
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "enforce_dictionary_check": true,
- "enforce_username_check": true,
- "lockout_duration": 3600000,
- "max_login_attempts": 10,
- "max_password_age": 86400000,
- "min_character_groups": 3,
- "min_characters_per_group": 1,
- "min_password_age": 86400000,
- "min_password_length": 1,
- "password_history": 5
}
]
}Manages Quality of Service (QoS) policies. These policies define controls that can be configured and attached to managed objects to guarantee performance of workloads.
GET qos-policies
List QoS policies.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "max_total_bytes_per_sec": 1048576,
- "max_total_ops_per_sec": 100
}
]
}POST qos-policies
Create a QoS policy.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
| max_total_bytes_per_sec | integer <int64> [ 1048576 .. 549755813888 ] The maximum allowed bytes/s totaled across all the clients.
Throttling occurs when the total bandwidth exceeds this limit.
Minimum limit is 1MB/s and maximum limit is 512GB/s.
If not specified at creation time, defaults to |
| max_total_ops_per_sec | integer <int64> [ 100 .. 100000000 ] The maximum allowed operations/s totaled across all the clients.
Throttling occurs when the total IOPs exceeds this limit.
Minimum limit is 100 IOPs/s and maximum limit is 100M IOPs/s.
If not specified at creation time, defaults to |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "max_total_bytes_per_sec": 1048576,
- "max_total_ops_per_sec": 100
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "max_total_bytes_per_sec": 1048576,
- "max_total_ops_per_sec": 100
}
]
}DELETE qos-policies
Delete a QoS policy.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH qos-policies
Modify a QoS policy.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
| max_total_bytes_per_sec | integer <int64> [ 1048576 .. 549755813888 ] The maximum allowed bytes/s totaled across all the clients.
Throttling occurs when the total bandwidth exceeds this limit.
Minimum limit is 1MB/s and maximum limit is 512GB/s.
If not specified at creation time, defaults to |
| max_total_ops_per_sec | integer <int64> [ 100 .. 100000000 ] The maximum allowed operations/s totaled across all the clients.
Throttling occurs when the total IOPs exceeds this limit.
Minimum limit is 100 IOPs/s and maximum limit is 100M IOPs/s.
If not specified at creation time, defaults to |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "max_total_bytes_per_sec": 1048576,
- "max_total_ops_per_sec": 100
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "max_total_bytes_per_sec": 1048576,
- "max_total_ops_per_sec": 100
}
]
}GET qos-policies/file-systems
List qos policies and their file system members.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}GET qos-policies/members
List qos policies and their managed object members.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}GET qos-policies/buckets
List qos policies and their bucket members.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}An SMB Client policy manages access to SMB file systems on a per-client basis. These policies can be applied to one or more file systems.
GET smb-client-policies
Display SMB Client policies and their attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "access_based_enumeration_enabled": true,
- "rules": [
- {
- "id": "string",
- "name": "string",
- "client": "string",
- "encryption": "optional",
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0
}
]
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST smb-client-policies
Create a new SMB Client policy.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
| access_based_enumeration_enabled | boolean If set to |
Array of objects (SmbClientPolicyRulePostInPolicy) <= 200 items All of the rules that are part of this policy. The order is the evaluation order. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "access_based_enumeration_enabled": true,
- "rules": [
- {
- "client": "1.2.3.4",
- "encryption": "optional",
- "permission": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "access_based_enumeration_enabled": true,
- "rules": [
- {
- "id": "string",
- "name": "string",
- "client": "string",
- "encryption": "optional",
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0
}
]
}
]
}DELETE smb-client-policies
Delete one or more SMB Client policies.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH smb-client-policies
Modify an existing SMB Client policy's attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
| access_based_enumeration_enabled | boolean If set to |
Array of objects (SmbClientPolicyRuleInPolicy) <= 200 items All of the rules that are part of this policy. The order is the evaluation order. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "access_based_enumeration_enabled": true,
- "rules": [
- {
- "client": "string",
- "encryption": "optional",
- "permission": "string",
- "policy": { }
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "version": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "access_based_enumeration_enabled": true,
- "rules": [
- {
- "id": "string",
- "name": "string",
- "client": "string",
- "encryption": "optional",
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0
}
]
}
]
}GET smb-client-policies/rules
Displays a list of SMB Client policy rules. The default sort is by policy name, then index.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "client": "string",
- "encryption": "optional",
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0,
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST smb-client-policies/rules
Add an SMB Client policy rule.
Rules are ordered in three groups; ip addresses, other and *.
The new rule will be added at the end of the appropriate group if neither
before_rule_id nor before_rule_name are specified.
Rules can only be inserted into the appropriate group.
The policy_ids or policy_names parameter is required, but they cannot be
set together.
Authorizations:
query Parameters
| before_rule_id | string The id of the rule to insert or move a rule before.
This cannot be provided together with the |
| before_rule_name | string The name of the rule to insert or move a rule before.
This cannot be provided together with the |
| 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 |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| client | string Specifies the clients that will be permitted to access the export.
Accepted notation is a single IP address, subnet in CIDR notation,
or anonymous ( |
| encryption | string Specifies whether the remote client is required to use SMB encryption. Valid values are
|
| permission | string Specifies which read-write client access permissions are allowed for the export.
Valid values are |
| index | integer <int32> The index within the policy. The |
Responses
Request samples
- Payload
{- "client": "1.2.3.4",
- "encryption": "optional",
- "permission": "string",
- "index": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "client": "string",
- "encryption": "optional",
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0,
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE smb-client-policies/rules
Delete one or more SMB Client policy rules.
One of the following is required: ids or names.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH smb-client-policies/rules
Modify an existing SMB Client policy rule.
If before_rule_id or before_rule_name are specified, the rule will be
moved before that rule.
Rules are ordered in three groups; ip addresses, other and * and can only
be moved within the appropriate group.
One of the following is required: ids or names.
Authorizations:
query Parameters
| before_rule_id | string The id of the rule to insert or move a rule before.
This cannot be provided together with the |
| before_rule_name | string The name of the rule to insert or move a rule before.
This cannot be provided together with the |
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| versions | Array of strings A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn't match the value in the query param. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| client | string Specifies the clients that will be permitted to access the export.
Accepted notation is a single IP address, subnet in CIDR notation,
or anonymous ( |
| encryption | string Specifies whether the remote client is required to use SMB encryption. Valid values are
|
| permission | string Specifies which read-write client access permissions are allowed for the export.
Valid values are |
object (FixedReference) The policy to which this rule belongs. | |
| index | integer <int32> The index within the policy. The |
Responses
Request samples
- Payload
{- "client": "string",
- "encryption": "optional",
- "permission": "string",
- "policy": { },
- "index": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "client": "string",
- "encryption": "optional",
- "permission": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_version": "string",
- "index": 0,
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}A snapshot policy manages the creation file system snapshots or it can applied to file system and object replication links for replication. These policies provide the user a way to control the frequency of creating snapshots and objects, and the retention time for each copy. A snapshot policy can be applied to one or more file systems, objects, or replication links.
GET policies
Display snapshot scheduling policies and their attributes.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "retention_lock": "string",
- "rules": [
- {
- "at": 0,
- "every": 0,
- "keep_for": 0,
- "time_zone": "America/Los_Angeles"
}
]
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST policies
Create a new snapshot scheduling policy with rule attributes to capture file system snapshots for a set period of time and frequency, as well as how long snapshots are retained before being destroyed and eradicated.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
Array of objects (_policy_rule) |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "rules": [
- {
- "at": 0,
- "every": 0,
- "keep_for": 0,
- "time_zone": "America/Los_Angeles"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "retention_lock": "string",
- "rules": [
- {
- "at": 0,
- "every": 0,
- "keep_for": 0,
- "time_zone": "America/Los_Angeles"
}
]
}
]
}DELETE policies
Delete one or more snapshot scheduling policies.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH policies
Modify a snapshot scheduling policy’s attributes for when and how often snapshots are created and how long they are retained.
Authorizations:
query Parameters
| 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_snapshots | boolean This parameter must be set to |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
Array of objects (_policy_rule) | |
Array of objects (_policy_rule) | |
Array of objects (_policy_rule) |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "rules": [
- {
- "at": 0,
- "every": 0,
- "keep_for": 0,
- "time_zone": "America/Los_Angeles"
}
], - "add_rules": [
- {
- "at": 0,
- "every": 0,
- "keep_for": 0,
- "time_zone": "America/Los_Angeles"
}
], - "remove_rules": [
- {
- "at": 0,
- "every": 0,
- "keep_for": 0,
- "time_zone": "America/Los_Angeles"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "retention_lock": "string",
- "rules": [
- {
- "at": 0,
- "every": 0,
- "keep_for": 0,
- "time_zone": "America/Los_Angeles"
}
]
}
]
}GET policies/file-systems
List file systems mapped to a snapshot scheduling policy. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST policies/file-systems
Map a file system to a snapshot scheduling policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE policies/file-systems
Remove the snapshot scheduling policy mapped to a file system.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET policies/file-system-snapshots
List file system snapshots mapped to a snapshot scheduling policy. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}DELETE policies/file-system-snapshots
Remove the snapshot scheduling policy mapped to a file system.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET policies/members
List snapshot scheduling policies mapped to file systems, snapshots, and file system replica links. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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 |
| local_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| member_types | Array of strings A comma-separated list of member types. Valid values are |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| remote_file_system_ids | Array of strings A comma-separated list of remote file system IDs. If 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_file_system_names | Array of strings A comma-separated list of remote file system names. If there is not at
least one resource that matches each of the elements, then an error is
returned. This cannot be provided together with the |
| remote_ids | 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 Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "link": {
- "local_file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote": {
- "id": "string",
- "name": "string"
}, - "remote_file_system": {
- "id": "string",
- "name": "string"
}
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}GET policies/file-system-replica-links
List snapshot scheduling policies for file system replica links. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.
Authorizations:
query Parameters
| 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 |
| local_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| remote_file_system_ids | Array of strings A comma-separated list of remote file system IDs. If 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_file_system_names | Array of strings A comma-separated list of remote file system names. If there is not at
least one resource that matches each of the elements, then an error is
returned. This cannot be provided together with the |
| remote_ids | 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 Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "link": {
- "local_file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote": {
- "id": "string",
- "name": "string"
}, - "remote_file_system": {
- "id": "string",
- "name": "string"
}
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST policies/file-system-replica-links
Add a snapshot scheduling policy to a file system replica link.
Authorizations:
query Parameters
| 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_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "display_name": "irp624-c02:fs1",
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "link": {
- "local_file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote": {
- "id": "string",
- "name": "string"
}, - "remote_file_system": {
- "id": "string",
- "name": "string"
}
}
}
]
}DELETE policies/file-system-replica-links
Remove a snapshot scheduling policy mapped to a file system replica link.
Authorizations:
query Parameters
| 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_file_system_ids | Array of strings A comma-separated list of local file system IDs. If after filtering,
there is not at least one resource that matches each of the elements,
then an error is returned. This cannot be provided together with the
|
| local_file_system_names | Array of strings A comma-separated list of local file system names. If there is not
at least one resource that matches each of the elements, then an error
is returned. This cannot be provided together with |
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| 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 |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
An SSH Certificate Authority policy manages the keys that are allowed to sign user SSH certificates for access to the array, as well as the principals that they require be encoded in certificates to authenticate. These policies can be applied to one or more users, or as a default for all users.
A storage class tiering policy manages the criteria for tiering data within a filesystem from one storage class to another. These policies can be applied to one or more filesystems. Supported storage classes are S500X-S for speed, and S500X-A for archival.
GET storage-class-tiering-policies
List storage class tiering policies.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "archival_rules": [
- {
- "target_storage_class": "S500X-A",
- "time": 86400000,
- "type": "LATEST_ACCESS"
}
], - "retrieval_rules": [
- {
- "target_storage_class": "S500X-S",
- "type": "ON_READ"
}
]
}
]
}POST storage-class-tiering-policies
Create a storage class tiering policy.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
Array of objects (TieringPolicyArchivalRule) The list of archival rules for this policy. | |
Array of objects (TieringPolicyRetrievalRule) The list of retrieval rules for this policy. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "archival_rules": [
- {
- "time": 86400000,
- "type": "LATEST_ACCESS"
}
], - "retrieval_rules": [
- {
- "type": "ON_READ"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "archival_rules": [
- {
- "target_storage_class": "S500X-A",
- "time": 86400000,
- "type": "LATEST_ACCESS"
}
], - "retrieval_rules": [
- {
- "target_storage_class": "S500X-S",
- "type": "ON_READ"
}
]
}
]
}DELETE storage-class-tiering-policies
Delete a storage class tiering policy. Deletion is not allowed if the policy is attached to one or more file systems.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH storage-class-tiering-policies
Modify a storage class tiering policy.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
Array of objects (TieringPolicyArchivalRule) The list of archival rules for this policy. | |
Array of objects (TieringPolicyRetrievalRule) The list of retrieval rules for this policy. |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "archival_rules": [
- {
- "time": 86400000,
- "type": "LATEST_ACCESS"
}
], - "retrieval_rules": [
- {
- "type": "ON_READ"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "archival_rules": [
- {
- "target_storage_class": "S500X-A",
- "time": 86400000,
- "type": "LATEST_ACCESS"
}
], - "retrieval_rules": [
- {
- "target_storage_class": "S500X-S",
- "type": "ON_READ"
}
]
}
]
}GET storage-class-tiering-policies/members
List members mapped to a storage class tiering policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}A TLS policy manages the allowed TLS versions and ciphers for incoming network traffic to the system. These policies can be applied at the array level, or to individual network IPs.
GET network-interfaces/tls-policies
List network interface TLS policies.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST network-interfaces/tls-policies
Apply a TLS policy to a specific network interface. A given network interface may only have 1 TLS policy applied to it at any given time.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE network-interfaces/tls-policies
Remove a TLS policy from a network interface.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
List TLS policies
List TLS policies
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| effective | boolean If |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| purity_defined | boolean If |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "appliance_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "client_certificates_required": true,
- "disabled_tls_ciphers": [
- "string"
], - "enabled_tls_ciphers": [
- "string"
], - "min_tls_version": "string",
- "trusted_client_certificate_authority": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "verify_client_certificate_trust": true
}
]
}Create TLS policies
Creates TLS policies.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
object (ReferenceWritable) A reference to a certificate that will be presented as the server certificate in TLS negotiations with any clients that connect to appliance network addresses to which this policy applies. | |
| client_certificates_required | boolean If |
| disabled_tls_ciphers | Array of strings <= 16 items If specified, disables the specific TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, disabled ciphers must still result in at least one cipher being available for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on disabled ciphers. |
| enabled_tls_ciphers | Array of strings <= 16 items If specified, enables only the specified TLS ciphers. If all TLS ciphers
that are available for a specific TLS version on the system are disabled, then client
access over that TLS version is not possible. As such, the enabled ciphers must always
contain at least one cipher for each enabled TLS version.
Changes to this setting can disrupt traffic for any clients relying on ciphers that
are removed. If set to |
| min_tls_version | string The minimum TLS version that will be allowed for inbound connections on IPs to
which this policy applies. Changing this setting can disrupt connections for
any clients relying on older TLS versions that are disabled.
If set to |
object (ReferenceWritable) A reference to a certificate or certificate group.
The certificate referenced, or the certificates in the referenced group,
will be used to verify the certificates presented by clients when
| |
| verify_client_certificate_trust | boolean If |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "appliance_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "client_certificates_required": true,
- "disabled_tls_ciphers": [
- "string"
], - "enabled_tls_ciphers": [
- "string"
], - "min_tls_version": "string",
- "trusted_client_certificate_authority": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "verify_client_certificate_trust": true
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "appliance_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "client_certificates_required": true,
- "disabled_tls_ciphers": [
- "string"
], - "enabled_tls_ciphers": [
- "string"
], - "min_tls_version": "string",
- "trusted_client_certificate_authority": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "verify_client_certificate_trust": true
}
]
}Delete TLS policies
Deletes TLS policies.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Modify TLS policies
Modifies one or more attributes of TLS policies.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
object (FixedReference) Reference to the array where the policy is defined. | |
object (ReferenceWritable) A reference to a certificate that will be presented as the server certificate in TLS negotiations with any clients that connect to appliance network addresses to which this policy applies. | |
| client_certificates_required | boolean If |
| disabled_tls_ciphers | Array of strings <= 16 items If specified, disables the specific TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, disabled ciphers must still result in at least one cipher being available for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on disabled ciphers. |
| enabled_tls_ciphers | Array of strings <= 16 items If specified, enables only the specified TLS ciphers. If all TLS ciphers
that are available for a specific TLS version on the system are disabled, then client
access over that TLS version is not possible. As such, the enabled ciphers must always
contain at least one cipher for each enabled TLS version.
Changes to this setting can disrupt traffic for any clients relying on ciphers that
are removed. If set to |
| min_tls_version | string The minimum TLS version that will be allowed for inbound connections on IPs to
which this policy applies. Changing this setting can disrupt connections for
any clients relying on older TLS versions that are disabled.
If set to |
object (ReferenceWritable) A reference to a certificate or certificate group.
The certificate referenced, or the certificates in the referenced group,
will be used to verify the certificates presented by clients when
| |
| verify_client_certificate_trust | boolean If |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "appliance_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "client_certificates_required": true,
- "disabled_tls_ciphers": [
- "string"
], - "enabled_tls_ciphers": [
- "string"
], - "min_tls_version": "string",
- "trusted_client_certificate_authority": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "verify_client_certificate_trust": true
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "appliance_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "client_certificates_required": true,
- "disabled_tls_ciphers": [
- "string"
], - "enabled_tls_ciphers": [
- "string"
], - "min_tls_version": "string",
- "trusted_client_certificate_authority": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "verify_client_certificate_trust": true
}
]
}GET tls-policies/members
List TLS policies mapped to the array as a whole, or to one or more specific objects on the array (such as network interfaces).
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}GET tls-policies/network-interfaces
List network interface TLS policies.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}POST tls-policies/network-interfaces
Apply a TLS policy to a specific network interface. A given network interface may only have 1 TLS policy applied to it at any given time.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE tls-policies/network-interfaces
Remove a TLS policy from a network interface.
Authorizations:
query Parameters
| member_ids | Array of strings A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Manages WORM data for file systems. These policies are composed of retention periods, lock type, and auto-commit status.
GET worm-data-policies
List WORM data policies.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "default_retention": 0,
- "max_retention": 0,
- "min_retention": 0,
- "mode": "string",
- "retention_lock": "unlocked",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST worm-data-policies
Create a WORM data policy.
Authorizations:
query Parameters
| 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 A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
| location | object (FixedReference) Recursive Reference to the array where the policy is defined. |
| default_retention | integer <int64> Default retention period, in milliseconds. If the access time is not specified when committing a file, then the default retention period is applied. |
| max_retention | integer <int64> Maximum retention period, in milliseconds. |
| min_retention | integer <int64> Minimum retention period, in milliseconds. |
| mode | string The type of the retention lock. Valid values is |
| retention_lock | string If set to |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "default_retention": 0,
- "max_retention": 0,
- "min_retention": 0,
- "mode": "string",
- "retention_lock": "unlocked"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "default_retention": 0,
- "max_retention": 0,
- "min_retention": 0,
- "mode": "string",
- "retention_lock": "unlocked",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE worm-data-policies
Delete a WORM data policy. Deletion is not allowed if the policy is attached to one or more file systems.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH worm-data-policies
Modify a WORM data policy.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| enabled | boolean If |
| location | object (FixedReference) Recursive Reference to the array where the policy is defined. |
| default_retention | integer <int64> Default retention period, in milliseconds. If the access time is not specified when committing a file, then the default retention period is applied. |
| max_retention | integer <int64> Maximum retention period, in milliseconds. |
| min_retention | integer <int64> Minimum retention period, in milliseconds. |
| mode | string The type of the retention lock. Valid values is |
| retention_lock | string If set to |
Responses
Request samples
- Payload
{- "name": "string",
- "enabled": true,
- "location": { },
- "default_retention": 0,
- "max_retention": 0,
- "min_retention": 0,
- "mode": "string",
- "retention_lock": "unlocked"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "is_local": true,
- "location": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy_type": "string",
- "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "default_retention": 0,
- "max_retention": 0,
- "min_retention": 0,
- "mode": "string",
- "retention_lock": "unlocked",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}GET worm-data-policies/members
List members mapped to a WORM data policy.
Authorizations:
query Parameters
| 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 A comma-separated list of member IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| member_names | Array of strings A comma-separated list of member names. |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| policy_ids | Array of strings A comma-separated list of policy IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| policy_names | Array of strings A comma-separated list of policy names. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}Public Keys can be configured for reference in other configurations as signing keys are used to verify cryptographic signatures.
List public key configurations
List public key configurations.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "public_key": "string",
- "algorithm": "rsa",
- "key_size": 2048
}
]
}Create public key configurations
Creates public key configurations.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| public_key | string <= 5400 characters The text of the public key. May be PEM-formatted or OpenSSH-formatted at the time of input. |
Responses
Request samples
- Payload
{- "public_key": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "public_key": "string",
- "algorithm": "rsa",
- "key_size": 2048
}
]
}Delete public key configurations
Deletes public key configurations.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
GET public-keys/uses
List how public keys are being used and by what.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "use": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}A quota manages a set amount of space on a file system which a user or group may write to. A quota can be applied to a user or group of a specified file system. Once a user or group reaches their quota they will no longer be able to write to that file system.
GET quotas/groups
List groups with hard limit quotas.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| gids | Array of integers <int32> A comma-separated list of group IDs.
If there is not at least one resource that matches
each of the elements of |
| group_names | Array of strings A comma-separated list of group names.
If there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system_default_quota": 0,
- "group": {
- "id": 0,
- "name": "string"
}, - "quota": 0,
- "usage": 0
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST quotas/groups
Create a hard limit quota for a group.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| gids | Array of integers <int32> A comma-separated list of group IDs.
If there is not at least one resource that matches
each of the elements of |
| group_names | Array of strings A comma-separated list of group names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| quota required | integer <int64> The space limit of the quota (in bytes) for the specified group, cannot
be |
Responses
Request samples
- Payload
{- "quota": 0
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system_default_quota": 0,
- "group": {
- "id": 0,
- "name": "string"
}, - "quota": 0,
- "usage": 0
}
]
}DELETE quotas/groups
Delete a hard limit quota for a group.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| gids | Array of integers <int32> A comma-separated list of group IDs.
If there is not at least one resource that matches
each of the elements of |
| group_names | Array of strings A comma-separated list of group names.
If there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH quotas/groups
Modify a quota for a group. Note that if you modify a group's quota to a lower value and that group's usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| gids | Array of integers <int32> A comma-separated list of group IDs.
If there is not at least one resource that matches
each of the elements of |
| group_names | Array of strings A comma-separated list of group names.
If there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| quota required | integer <int64> The space limit of the quota (in bytes) for the specified group, cannot
be |
Responses
Request samples
- Payload
{- "quota": 0
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system_default_quota": 0,
- "group": {
- "id": 0,
- "name": "string"
}, - "quota": 0,
- "usage": 0
}
]
}GET quotas-settings
List notification attributes of a group or user quota.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "contact": "John Doe, john@example.com",
- "direct_notifications_enabled": true
}
]
}PATCH quotas-settings
Modify the notification attributes of a group or user quota.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| contact | string The contact information that will be provided in any notifications sent directly to users and groups. This can be an email, a phone number, a name, or some other form of contact information. |
| direct_notifications_enabled | boolean Are notifications regarding space usage and quotas being sent directly to user and group emails? |
Responses
Request samples
- Payload
{- "contact": "John Doe, john@example.com",
- "direct_notifications_enabled": true
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "contact": "John Doe, john@example.com",
- "direct_notifications_enabled": true
}
]
}GET quotas/users
List users with hard limit file system quotas.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| 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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| uids | Array of integers <int32> A comma-separated list of user IDs.
If there is not at least one resource that matches
each of the elements of |
| user_names | Array of strings A comma-separated list of user names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system_default_quota": 0,
- "quota": 0,
- "usage": 0,
- "user": {
- "id": 0,
- "name": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST quotas/users
Create a hard limit file system quota for a user.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| uids | Array of integers <int32> A comma-separated list of user IDs.
If there is not at least one resource that matches
each of the elements of |
| user_names | Array of strings A comma-separated list of user names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| quota required | integer <int64> The limit of the quota (in bytes) for the specified user, cannot be |
Responses
Request samples
- Payload
{- "quota": 0
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system_default_quota": 0,
- "quota": 0,
- "usage": 0,
- "user": {
- "id": 0,
- "name": "string"
}
}
]
}DELETE quotas/users
Delete a hard limit file system quota for a user.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| uids | Array of integers <int32> A comma-separated list of user IDs.
If there is not at least one resource that matches
each of the elements of |
| user_names | Array of strings A comma-separated list of user names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH quotas/users
Modify the attributes of a hard limit file system quota. Note that if you modify a user's quota to a lower value and that user’s usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| uids | Array of integers <int32> A comma-separated list of user IDs.
If there is not at least one resource that matches
each of the elements of |
| user_names | Array of strings A comma-separated list of user names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| quota required | integer <int64> The limit of the quota (in bytes) for the specified user, cannot be |
Responses
Request samples
- Payload
{- "quota": 0
}Response samples
- 200
{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system_default_quota": 0,
- "quota": 0,
- "usage": 0,
- "user": {
- "id": 0,
- "name": "string"
}
}
]
}A realm provides a means to compartmentalize storage resources, access, and isolate administration of all contained resources.
GET realms
Displays a list of realms.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| destroyed | boolean If set to For destroyed objects, the time remaining is displayed in milliseconds. 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "created": 0,
- "default_inbound_tls_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time_remaining": 0
}
], - "total": {
- "id": "string",
- "name": "string",
- "created": 0,
- "default_inbound_tls_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time_remaining": 0
}
}POST realms
Create a new realm.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
| without_default_access_list required | boolean Specifying this option ensures a realm is created without any resource accesses. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "created": 0,
- "default_inbound_tls_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time_remaining": 0
}
]
}DELETE Realms
Deletes a realm that has been destroyed and is pending eradication. Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH realms
Modify an existing realm's attributes, including destroying a realm.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
object (ReferenceWritable) The default TLS policy governing inbound traffic from clients accessing the accessing the realm's
network interfaces. This TLS policy will be applied for any IP addresses within the realm that do not
have a specific policy applied to them at a more granular level. If no | |
| destroyed | boolean Returns a value of |
Responses
Request samples
- Payload
{- "name": "string",
- "default_inbound_tls_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "created": 0,
- "default_inbound_tls_policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time_remaining": 0
}
]
}GET realms/space
List used storage space for the realm.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| total_only | boolean If set to |
| type | string Display the metric of a specified object type.
Valid values are |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time": 0
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time": 0
}
]
}GET realms/space/storage-classes
List used storage space for storage classes in the realm.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| storage_class_names | Array of strings A comma-separated list of storage class names. Valid values include |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time": 0,
- "storage_class": "string"
}
], - "total": {
- "id": "string",
- "name": "string",
- "space": {
- "available_provisioned": 19937690345472,
- "available_ratio": 0,
- "data_reduction": 0,
- "destroyed": 0,
- "destroyed_virtual": 0,
- "shared": 0,
- "snapshots": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_used": 0,
- "unique": 0,
- "virtual": 19937690345472
}, - "time": 0,
- "storage_class": "string"
}
}Remote arrays provide the ability to list and manage all the remote arrays known to an array.
List remote arrays
Lists arrays in the current fleet, as well as arrays that the current array has existing replication connections to.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| current_fleet_only | boolean If current_fleet_only is specified, then results will only show arrays from the same fleet to which the current array is a member of. |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "fleet": {
- "id": "string",
- "name": "string",
- "resource_type": "string",
- "is_local": true
}, - "is_local": false,
- "model": "FlashBlade//S200",
- "os": "Purity//FB",
- "version": "4.4.99"
}
]
}Resource Access captures sharing of a resource to a scope, e.g. sharing a dns to a realm.
GET resource-accesses
Returns a list of configured resource accesses.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=10 Limit the size of the response to the specified number of resources.
A |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "more_items_remaining": false,
- "items": [
- {
- "id": "string",
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "scope": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}DELETE resource-accesses
Delete resource access object.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
POST resource-accesses/batch
Create resource access objects.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (ReferenceWritable) Resource to which the scope has access to. | |
object (ReferenceWritable) Scope which has access to the resource. |
Responses
Request samples
- Payload
[- {
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "scope": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]Response samples
- 200
{- "items": [
- {
- "id": "string",
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "scope": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Displays Rapid Data Locking (RDL) configuration and performs functionality tests of the associated Enterprise Key Management (EKM) servers.
Get the status of the Rapid Data Locking feature.
Displays the status of the Rapid Data Locking feature.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "enabled": true,
- "kmip_server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Modifies the Rapid Data Locking feature.
Modifies the Rapid Data Locking feature. Note that the feature can only be enabled if there are no file systems nor buckets created on the array. Once enabled, the feature cannot be modified.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| enabled | boolean
|
object (Reference) The KMIP server configuration associated with RDL. |
Responses
Request samples
- Payload
{- "enabled": true,
- "kmip_server": {
- "id": "string",
- "name": "string"
}
}Response samples
- 200
{- "items": [
- {
- "enabled": true,
- "kmip_server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Displays Rapid Data Locking test results.
Displays a detailed result of a Rapid Data Locking test.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
]
}Displays role attributes. Each user of the array is assigned to a role and each role has a set of role based access controls (RBAC). The roles (array_admin, storage_admin, ops_admin, readonly, and Invalid - multiple roles) have a specified set of permissions that allow certain actions to be performed on the array. Each role includes a listing REST actions allowable for each endpoint.
GET roles
List roles and permission attributes for role-based access control (RBAC).
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- {
- "action": "get",
- "resource_type": "file-systems"
}
]
}
]
}SAML2 SSO allows customers to configure settings of SAML2 service provider and identity provider. It provides a multi-factor authentication (MFA) mechanism for customers to log in to FlashBlade.
List SAML2 SSO configurations
Displays the SAML2 SSO service provider and identity provider configuration settings in the array.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "binding": "string",
- "enabled": true,
- "idp": {
- "encrypt_assertion_enabled": true,
- "metadata_url_ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "metadata_url_ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "sign_request_enabled": true,
- "verification_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "prn": "prn::iam:array-id/local::saml-provider/myidp",
- "services": [
- "string"
], - "sp": {
- "decryption_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "signing_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
},
}
}
]
}Create SAML2 SSO configurations
Creates SAML2 SSO configurations.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| array_url | string The URL of the array. |
| binding | string SAML2 binding to use for the request from Flashblade to the Identity
Provider.
Valid values: |
| enabled | boolean If set to |
object (_saml2SsoIdp) Properties specific to the identity provider. | |
| services | Array of strings Services that the SAML2 SSO authentication is used for.
Valid values: |
object (_saml2SsoSp) Properties specific to the service provider. |
Responses
Request samples
- Payload
{- "binding": "string",
- "enabled": true,
- "idp": {
- "encrypt_assertion_enabled": true,
- "metadata_url_ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "metadata_url_ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "sign_request_enabled": true,
- "verification_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "services": [
- "string"
], - "sp": {
- "decryption_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "signing_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "binding": "string",
- "enabled": true,
- "idp": {
- "encrypt_assertion_enabled": true,
- "metadata_url_ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "metadata_url_ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "sign_request_enabled": true,
- "verification_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "prn": "prn::iam:array-id/local::saml-provider/myidp",
- "services": [
- "string"
], - "sp": {
- "decryption_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "signing_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
},
}
}
]
}Delete SAML2 SSO configurations
Deletes SAML2 SSO configurations.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Modify SAML2 SSO configurations
Modifies one or more attributes of SAML2 SSO configurations.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| array_url | string The URL of the array. |
| binding | string SAML2 binding to use for the request from Flashblade to the Identity
Provider.
Valid values: |
| enabled | boolean If set to |
object (_saml2SsoIdp) Properties specific to the identity provider. | |
| services | Array of strings Services that the SAML2 SSO authentication is used for.
Valid values: |
object (_saml2SsoSp) Properties specific to the service provider. |
Responses
Request samples
- Payload
{- "name": "string",
- "binding": "string",
- "enabled": true,
- "idp": {
- "encrypt_assertion_enabled": true,
- "metadata_url_ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "metadata_url_ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "sign_request_enabled": true,
- "verification_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "services": [
- "string"
], - "sp": {
- "decryption_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "signing_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "binding": "string",
- "enabled": true,
- "idp": {
- "encrypt_assertion_enabled": true,
- "metadata_url_ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "metadata_url_ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "sign_request_enabled": true,
- "verification_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "prn": "prn::iam:array-id/local::saml-provider/myidp",
- "services": [
- "string"
], - "sp": {
- "decryption_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "signing_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
},
}
}
]
}GET sso/saml2/idps/test
Test the existing SAML2 SSO configurations in the array.
Authorizations:
query Parameters
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
]
}PATCH sso/saml2/idps/test
Modifies and test the provided SAML2 SSO configurations. If the configurations with the
specified ids or names exist, the provided configurations will overwrite
the existing configurations, but will not be persisted in the array.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| array_url | string The URL of the array. |
| binding | string SAML2 binding to use for the request from Flashblade to the Identity
Provider.
Valid values: |
| enabled | boolean If set to |
object (_saml2SsoIdp) Properties specific to the identity provider. | |
| services | Array of strings Services that the SAML2 SSO authentication is used for.
Valid values: |
object (_saml2SsoSp) Properties specific to the service provider. |
Responses
Request samples
- Payload
{- "name": "string",
- "binding": "string",
- "enabled": true,
- "idp": {
- "encrypt_assertion_enabled": true,
- "metadata_url_ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "metadata_url_ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "sign_request_enabled": true,
- "verification_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "services": [
- "string"
], - "sp": {
- "decryption_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "signing_credential": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
}Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
]
}Manages the properties of servers. Servers are network and identity management access points for data.
GET servers
List servers.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "dns": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "created": 0,
- "directory_services": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST servers
Add a server.
Authorizations:
query Parameters
| create_ds required | string Example: create_ds=server1_nfs The name of the directory service object to create used for NFS access to this server.
The name must be the server |
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (_reference) <= 1 items The DNS config to be used by this server. |
Responses
Request samples
- Payload
{- "dns": [
- {
- "id": "string",
- "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "dns": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "created": 0,
- "directory_services": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}DELETE servers
Delete a server.
Authorizations:
query Parameters
| cascade_delete required | Array of strings Example: cascade_delete=directory-services The resource types to delete when deleting this object. It will fail if the resources are
referenced by other objects.
Valid values include |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH servers
Modify the server attributes.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
Array of objects (_reference) <= 1 items The DNS config to be used by this server. |
Responses
Request samples
- Payload
{- "dns": [
- {
- "id": "string",
- "name": "string"
}
]
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "dns": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "created": 0,
- "directory_services": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "realms": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}List session data
Displays session data for user login events performed in the Purity//FB GUI, CLI, and REST API.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "end_time": 1502234638,
- "event": "user session",
- "event_count": 3,
- "identifying_details": "'principal=\"john\",serial=0001,key_id=\"arbitrary CA key id text\",ssh_session_id=3233, ca_key_fingerprint=UWRGBqyUXxTc5FKhUCw+/0tlwDXYPY1yLZk20zSCoDI'",
- "location": "10.202.101.11",
- "method": "public key",
- "start_time": 1502234212,
- "user": "pureuser",
- "user_interface": "CLI"
}
]
}Manages Simple Mail Transfer Protocol (SMTP) settings. SMTP allows the array to send email notifications and alerts to recipients.
GET smtp-servers
List SMTP server attributes for the array network.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "encryption_mode": "starttls",
- "relay_host": "string",
- "sender_domain": "string"
}
]
}PATCH smtp-servers
Modify SMTP server attributes such as the relay host and sender domain.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| encryption_mode | string Enforces an encryption mode when sending alert email messages.
Valid values include |
| relay_host | string Relay server used as a forwarding point for email sent from the array.
Can be set as a hostname, IPv4 address, or IPv6 address, with optional port numbers.
The expected format for IPv4 is |
| sender_domain | string Domain name appended to alert email messages. |
Responses
Request samples
- Payload
{- "encryption_mode": "starttls",
- "relay_host": "string",
- "sender_domain": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "encryption_mode": "starttls",
- "relay_host": "string",
- "sender_domain": "string"
}
]
}Manages the Simple Network Management Protocol (SNMP) agents and displays the Management Information Base (MIB) file. The SNMP agent sends array component status information and alerts to the SNMP manager. The MIB file lists all manageable modules of the array.
GET snmp-agents
List SNMP agent attributes.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "engine_id": "80009e2205d7c0bd31fef5b87f4f44da",
- "v2c": {
- "community": "****"
}, - "v3": {
- "auth_passphrase": "****",
- "auth_protocol": "MD5",
- "privacy_passphrase": "****",
- "privacy_protocol": "DES",
- "user": "User1"
}, - "version": "v3"
}
]
}PATCH snmp-agents
Modify SNMP agent attributes.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object (_snmp_v2c) The v2c configurations of SNMP. | |
object (_snmp_v3) The v3 configurations of SNMP. | |
| version | string Version of the SNMP protocol to be used by an SNMP manager
in communications with Purity's SNMP agent.
Valid values are |
Responses
Request samples
- Payload
{- "v2c": {
- "community": "****"
}, - "v3": {
- "auth_passphrase": "****",
- "auth_protocol": "MD5",
- "privacy_passphrase": "****",
- "privacy_protocol": "DES",
- "user": "User1"
}, - "version": "v3"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "engine_id": "80009e2205d7c0bd31fef5b87f4f44da",
- "v2c": {
- "community": "****"
}, - "v3": {
- "auth_passphrase": "****",
- "auth_protocol": "MD5",
- "privacy_passphrase": "****",
- "privacy_protocol": "DES",
- "user": "User1"
}, - "version": "v3"
}
]
}Manages the Simple Network Management Protocol (SNMP) managers, including performing functionality tests. The SNMP manager receives array component status information and alerts from the SNMP agent.
GET snmp-managers
List SNMP managers and their attributes.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "host": "snmp.purestorage.com",
- "notification": "trap",
- "v2c": {
- "community": "****"
}, - "v3": {
- "auth_passphrase": "****",
- "auth_protocol": "MD5",
- "privacy_passphrase": "****",
- "privacy_protocol": "DES",
- "user": "User1"
}, - "version": "v3"
}
]
}POST snmp-managers
Create an SNMP manager.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| host | string DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity is to send trap messages when it generates alerts. |
| notification | string The type of notification the agent will send.
Valid values are |
object (_snmp_v2c) The v2c configurations of SNMP. | |
object (_snmp_v3_post) The v3 configurations of SNMP. | |
| version | string Version of the SNMP protocol to be used by Purity in communications
with the specified manager.
Valid values are |
Responses
Request samples
- Payload
{- "host": "snmp.purestorage.com",
- "notification": "trap",
- "v2c": {
- "community": "****"
}, - "v3": {
- "auth_passphrase": "****",
- "auth_protocol": "MD5",
- "privacy_passphrase": "****",
- "privacy_protocol": "DES",
- "user": "User1"
}, - "version": "v3"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "host": "snmp.purestorage.com",
- "notification": "trap",
- "v2c": {
- "community": "****"
}, - "v3": {
- "auth_passphrase": "****",
- "auth_protocol": "MD5",
- "privacy_passphrase": "****",
- "privacy_protocol": "DES",
- "user": "User1"
}, - "version": "v3"
}
]
}DELETE snmp-managers
Remove an SNMP manager.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH snmp-managers
Modify SNMP manager attributes such as versions.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| host | string DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity is to send trap messages when it generates alerts. |
| notification | string The type of notification the agent will send.
Valid values are |
object (_snmp_v2c) The v2c configurations of SNMP. | |
object (_snmp_v3) The v3 configurations of SNMP. | |
| version | string Version of the SNMP protocol to be used by Purity in communications
with the specified manager.
Valid values are |
Responses
Request samples
- Payload
{- "name": "string",
- "host": "snmp.purestorage.com",
- "notification": "trap",
- "v2c": {
- "community": "****"
}, - "v3": {
- "auth_passphrase": "****",
- "auth_protocol": "MD5",
- "privacy_passphrase": "****",
- "privacy_protocol": "DES",
- "user": "User1"
}, - "version": "v3"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "host": "snmp.purestorage.com",
- "notification": "trap",
- "v2c": {
- "community": "****"
}, - "v3": {
- "auth_passphrase": "****",
- "auth_protocol": "MD5",
- "privacy_passphrase": "****",
- "privacy_protocol": "DES",
- "user": "User1"
}, - "version": "v3"
}
]
}GET snmp-managers/test
Test if the configuration of an SNMP manager is valid.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
], - "total_item_count": 0
}List software check tasks
Displays a list of software check tasks.
Authorizations:
query Parameters
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| software_names | Array of strings A comma-separated list of software names. |
| software_versions | Array of strings A comma-separated list of target software versions. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| total_item_count | boolean If set to |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "end_time": 1567026888000,
- "start_time": 1567026779000,
- "checks": [
- {
- "details": "string",
- "name": "Empty Chassis Check",
- "status": "string"
}
], - "details": "string",
- "software_name": "string",
- "software_upgrade_hops": [
- "4.1.0",
- "4.1.1"
], - "software_version": "4.4.0",
- "status": "running"
}
]
}Create a software check task
Creates a software check task. To create a task, use a software name and version. If a task is already running, an error is returned.
Authorizations:
query Parameters
| software_names | Array of strings A comma-separated list of software names. |
| software_versions | Array of strings A comma-separated list of target software versions. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "end_time": 1567026888000,
- "start_time": 1567026779000,
- "checks": [
- {
- "details": "string",
- "name": "Empty Chassis Check",
- "status": "string"
}
], - "details": "string",
- "software_name": "string",
- "software_upgrade_hops": [
- "4.1.0",
- "4.1.1"
], - "software_version": "4.4.0",
- "status": "running"
}
]
}GET subnets
List the array’s subnets.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "gateway": "string",
- "interfaces": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "link_aggregation_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "mtu": 1280,
- "prefix": "1.2.3.0/24",
- "services": [
- "string"
], - "vlan": 0
}
]
}POST subnets
Create an array subnet.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| gateway | string The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network. |
object (Reference) Reference to the associated LAG. | |
| mtu | integer <int32> [ 1280 .. 9216 ] Maximum message transfer unit (packet) size for the subnet in bytes.
MTU setting cannot exceed the MTU of the corresponding physical
interface. If not specified, defaults to |
| prefix | string The IPv4 or IPv6 address to be associated with the specified subnet. |
| vlan | integer <int32> VLAN ID. |
Responses
Request samples
- Payload
{- "gateway": "string",
- "link_aggregation_group": {
- "id": "string",
- "name": "string"
}, - "mtu": 1280,
- "prefix": "1.2.3.0/24",
- "vlan": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "gateway": "string",
- "interfaces": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "link_aggregation_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "mtu": 1280,
- "prefix": "1.2.3.0/24",
- "services": [
- "string"
], - "vlan": 0
}
]
}DELETE subnets
Remove an array subnet.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH subnets
Modify array subnet attributes.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| gateway | string The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network. |
object (Reference) Reference to the associated LAG. | |
| mtu | integer <int32> [ 1280 .. 9216 ] Maximum message transfer unit (packet) size for the subnet in bytes.
MTU setting cannot exceed the MTU of the corresponding physical
interface. If not specified, defaults to |
| prefix | string The IPv4 or IPv6 address to be associated with the specified subnet. |
| vlan | integer <int32> VLAN ID. |
Responses
Request samples
- Payload
{- "gateway": "string",
- "link_aggregation_group": {
- "id": "string",
- "name": "string"
}, - "mtu": 1280,
- "prefix": "1.2.3.0/24",
- "vlan": 0
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "enabled": true,
- "gateway": "string",
- "interfaces": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "link_aggregation_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "mtu": 1280,
- "prefix": "1.2.3.0/24",
- "services": [
- "string"
], - "vlan": 0
}
]
}Manages support configurations for the array, including performing functionality tests. The remote assist and phone home feature provides supplement information to Pure Technical Services to assist with customer issues.
GET support
List Phone Home, Remote Assistance and Edge Management settings.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "edge_agent_update_enabled": true,
- "edge_management_enabled": true,
- "phonehome_enabled": true,
- "proxy": "string",
- "remote_assist_active": true,
- "remote_assist_duration": 86400000,
- "remote_assist_expires": "string",
- "remote_assist_opened": "string",
- "remote_assist_paths": [
- {
- "component_name": "string",
- "status": "connected"
}
], - "remote_assist_status": "connected"
}
]
}PATCH support
Modify Phone Home, Remote Assistance and Edge Management settings.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| edge_agent_update_enabled | boolean The switch to enable opt-in for edge agent updates. |
| edge_management_enabled | boolean The switch to enable opt-in for edge management. |
| phonehome_enabled | boolean The switch to enable phonehome. |
| proxy | string |
| remote_assist_active | boolean The switch to open all remote-assist sessions. |
| remote_assist_duration | integer <int64> Specifies the duration of the remote-assist session in milliseconds. This parameter should only be provided when establishing a new session. It determines the length of time the session will remain active after it's initiated. |
Responses
Request samples
- Payload
{- "edge_agent_update_enabled": true,
- "edge_management_enabled": true,
- "phonehome_enabled": true,
- "proxy": "string",
- "remote_assist_active": true,
- "remote_assist_duration": 86400000
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "edge_agent_update_enabled": true,
- "edge_management_enabled": true,
- "phonehome_enabled": true,
- "proxy": "string",
- "remote_assist_active": true,
- "remote_assist_duration": 86400000,
- "remote_assist_expires": "string",
- "remote_assist_opened": "string",
- "remote_assist_paths": [
- {
- "component_name": "string",
- "status": "connected"
}
], - "remote_assist_status": "connected"
}
]
}GET support-test
Test if the Phone Home and Remote Assistance settings are functioning properly.
Authorizations:
query Parameters
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| test_type | string Specifies the type of test. Valid values are |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
], - "total_item_count": 0
}Manages support diagnostics for the array, including performing diagnostics tasks, running tests, finding problems and giving remediation. The diagnostics tool provides a way to test the array components and generate a report of the results.
GET diagnostics list
Lists the support diagnostics tasks.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "analysis_period": {
- "end_time": 1567026888000,
- "start_time": 1567026779000
}, - "index": 1,
- "severity_count": [
- {
- "count": 1,
- "severity": "critical"
}
], - "start_time": 1567026779000,
- "status": "completed",
- "task_id": "string",
- "version": "1.0.4.0"
}
]
}Start a diagnostic task
Creates a diagnostics task for a given time interval.
If start_time is not provided, defaults to Current System Time - 1 hour.
If end_time is not provided, defaults to Current System Time.
If a task is already running, an error is returned.
Authorizations:
query Parameters
| analysis_period_end_time | integer <int64> >= 0 Example: analysis_period_end_time=1514764800000 When the analysis time window ends (in milliseconds since epoch). |
| analysis_period_start_time | integer <int64> >= 0 Example: analysis_period_start_time=1514764800000 When the analysis time window starts (in milliseconds since epoch). |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "analysis_period": {
- "end_time": 1567026888000,
- "start_time": 1567026779000
}, - "index": 1,
- "severity_count": [
- {
- "count": 1,
- "severity": "critical"
}
], - "start_time": 1567026779000,
- "status": "completed",
- "task_id": "string",
- "version": "1.0.4.0"
}
]
}GET diagnostics details
Lists the diagnostics tasks details.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "index": 1.1,
- "result_details": "Subnets does not exist for Mgmt services.",
- "severity": "critical",
- "task_id": "string",
- "test_name": "Subnet Check For Management Service",
- "test_type": "Generic"
}
]
}Manages syslog servers connected to the array, including performing functionality tests of syslog servers.
GET syslog-servers
Return a list of configured syslog servers.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "uri": "tcp://my.syslogserver.com",
- "services": [
- "string"
], - "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST syslog-servers
Configure a new syslog server.
Authorizations:
query Parameters
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| uri | string The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT. |
| services | Array of strings Valid values are |
Responses
Request samples
- Payload
{- "uri": "tcp://my.syslogserver.com",
- "services": [
- "string"
]
}Response samples
- 200
{- "items": [
- {
- "uri": "tcp://my.syslogserver.com",
- "services": [
- "string"
], - "id": "string",
- "name": "string"
}
]
}DELETE syslog-servers
Delete a configured syslog server and stop forwarding syslog messages.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH syslog-servers
Modify the URI or services of a configured syslog server.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| uri | string The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT. |
| services | Array of strings Valid values are |
Responses
Request samples
- Payload
{- "uri": "tcp://my.syslogserver.com",
- "services": [
- "string"
]
}Response samples
- 200
{- "items": [
- {
- "uri": "tcp://my.syslogserver.com",
- "services": [
- "string"
], - "id": "string",
- "name": "string"
}
]
}GET syslog-servers/settings
List the certificate or certificate group associated with the syslog servers.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}PATCH syslog-servers/settings
Modify the certificate or certificate group associated with the syslog servers.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
object An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the environment, like a host or a server. | |
object An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the environment, like a host or a server. |
Responses
Request samples
- Payload
{- "ca_certificate": {
- "id": "string",
- "name": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string"
}
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}GET syslog-servers/test
Send test messages to conifgured remote syslog servers.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "items": [
- {
- "component_address": "10.230.94.21",
- "component_name": "fm1",
- "description": "Testing phonehome connectivity",
- "destination": "ra.cloud-support.purestorage.com",
- "enabled": true,
- "resource": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "result_details": "Timeout connecting to phonehome endpoint",
- "success": true,
- "test_type": "phonehome"
}
], - "total_item_count": 0
}Manages targets for replication, including viewing the performance metrics of active replication operations.
GET targets
List targets used for replication.
Authorizations:
query Parameters
| 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 A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "address": "string",
- "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string",
- "status_details": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}POST targets
Add a target for replication.
Authorizations:
query Parameters
| names required | Array of strings A comma-separated list of resource names. |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| address | string IP address or FQDN of the target system. |
Responses
Request samples
- Payload
{- "address": "string"
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "address": "string",
- "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string",
- "status_details": "string"
}
]
}DELETE targets
Delete the connection to the target for replication.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
PATCH targets
Modify the target attributes for replication.
Authorizations:
query Parameters
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| names | Array of strings A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| name | string A name chosen by the user. Can be changed. Must be locally unique. |
| address | string IP address or FQDN of the target system. |
object (FixedReference) The group of CA certificates that can be used, in addition to
well-known Certificate Authority certificates, in order to
establish a secure connection to the target system.
Defaults to a reference to the |
Responses
Request samples
- Payload
{- "name": "string",
- "address": "string",
- "ca_certificate_group": { }
}Response samples
- 200
{- "items": [
- {
- "id": "string",
- "name": "string",
- "address": "string",
- "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "status": "string",
- "status_details": "string"
}
]
}GET targets/performance/replication
List replication performance metrics for targets.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| end_time | integer <int64> >= 0 Example: end_time=1514764800000 When the time window ends (in milliseconds since epoch). |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| ids | Array of strings A comma-separated list of resource IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 A comma-separated list of resource names.
If there is not at least one resource that matches
each of the elements of |
| offset | integer <int32> >= 0 Example: offset=10 The offset of the first resource to return from a collection. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The desired ms between samples. Available resolutions may
depend on data type, |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| start_time | integer <int64> >= 0 Example: start_time=1514764800000 When the time window starts (in milliseconds since epoch). |
| total_only | boolean If set to |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "aggregate": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "continuous": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0,
- "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}
}, - "periodic": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "time": 0
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "aggregate": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "continuous": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0,
- "object_backlog": {
- "bytes_count": 0,
- "delete_ops_count": 0,
- "other_ops_count": 0,
- "put_ops_count": 0
}
}, - "periodic": {
- "received_bytes_per_sec": 0,
- "transmitted_bytes_per_sec": 0
}, - "time": 0
}
]
}Manages policies that control assuming Object Store Roles by external federated entities via Identity Providers
GET usage/groups
List groups with hard limit quotas and their file system usage.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| gids | Array of integers <int32> A comma-separated list of group IDs.
If there is not at least one resource that matches
each of the elements of |
| group_names | Array of strings A comma-separated list of group names.
If there is not at least one resource that matches
each of the elements of |
| limit | integer <int32> >= 0 Example: limit=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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system_default_quota": 0,
- "group": {
- "id": 0,
- "name": "string"
}, - "quota": 0,
- "usage": 0
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}GET usage/users
List users with hard limit quotas and their file system usage.
Authorizations:
query Parameters
| 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 A comma-separated list of file system IDs.
If after filtering, there is not at least one resource that matches
each of the elements of |
| file_system_names | Array of strings A comma-separated list of file system names.
If there is not at least one resource that matches
each of the elements of |
| 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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
| uids | Array of integers <int32> A comma-separated list of user IDs.
If there is not at least one resource that matches
each of the elements of |
| user_names | Array of strings A comma-separated list of user names.
If there is not at least one resource that matches
each of the elements of |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "file_system_default_quota": 0,
- "quota": 0,
- "usage": 0,
- "user": {
- "id": 0,
- "name": "string"
}
}
], - "errors": [
- {
- "context": "string",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Resource does not exist."
}
]
}GET verification-keys
List the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade.
Authorizations:
query Parameters
| continuation_token | string A token used to retrieve the next page of data
with some consistency guaranteed.
The token is a Base64 encoded value.
Set |
| 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 offset of the first resource to return from a collection. |
| sort | Array of strings Sort the response by the specified fields (in descending order if '-'
is appended to the field name).
NOTE: If you provide a sort you will not get a |
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Responses
Response samples
- 200
{- "continuation_token": "string",
- "total_item_count": 0,
- "items": [
- {
- "key_id": 1,
- "name": "string",
- "verification_key": "string"
}
]
}PATCH verification-keys
Update the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade.
Authorizations:
header Parameters
| X-Request-ID | string Supplied by client during request or generated by server. |
Request Body schema: application/json
| signed_verification_key | string The text of the signed verification key. |
Responses
Request samples
- Payload
{- "signed_verification_key": "string"
}Response samples
- 200
{- "items": [
- {
- "key_id": 1,
- "name": "string",
- "verification_key": "string"
}
]
}