FlashBlade® REST API 2.22 — AI-Optimized Reference

Base: https://{array}/ | Version: 2.22 | 226 paths | 538 ops | Auth: x-auth-token or api-token header

Auth

OAuth2 token exchange:

POST /oauth2/1.0/token
Content-Type: application/x-www-form-urlencoded
grant_type=urn:ietf:params:oauth:grant-type:token-exchange&subject_token=<API_TOKEN>&subject_token_type=urn:ietf:params:oauth:token-type:jwt
→ {access_token} → Authorization: Bearer <access_token>

Session login: POST /api/login (header api-token: <TOKEN>) → returns x-auth-token header Session logout: POST /api/logout (header x-auth-token: <TOKEN>) API version: GET /api/api_version → {versions: [string]}

Common Parameters

Most list (GET) endpoints support these query params:

Param	Type	Description
`allow_errors`	boolean (default: False)	If set to `true`, the API will allow the operation to continue even if there ...
`context_names`	array	Performs the operation on the context specified. If specified, the context n...
`context_names`	array	Performs the operation on the unique contexts specified. If specified, each ...
`continuation_token`	string	A token used to retrieve the next page of data with some consistency guarante...
`filter`	string	Narrows down the results to only the response objects that satisfy the filter...
`ids`	array	A comma-separated list of resource IDs. If after filtering, there is not at l...
`limit`	integer	Limits the size of the response to the specified number of objects on each pa...
`member_ids`	array	A comma-separated list of member IDs. If after filtering, there is not at lea...
`member_names`	array	A comma-separated list of member names.
`names`	array	Performs the operation on the unique names specified. Enter multiple names in...
`offset`	integer	The offset of the first resource to return from a collection.
`policy_ids`	array	A comma-separated list of policy IDs. If after filtering, there is not at lea...
`policy_names`	array	A comma-separated list of policy names.
`sort`	array	Sort the response by the specified fields (in descending order if '-' is appe...
`X-Request-ID`	string	Supplied by client during request or generated by server.

Filter syntax: field op value. Ops: =, !=, <, >, <=, >=, and, or, not. Example: filter=name='fs1' and provisioned>1048576

Endpoints

API Clients

GET /api/2.22/api-clients
POST /api/2.22/api-clients | Body: access_policies(array), access_token_ttl_in_ms(integer), issuer(string), max_role(object), public_key(string)
PATCH /api/2.22/api-clients | Body: access_policies(ro array), access_token_ttl_in_ms(ro integer), enabled(boolean), id(ro string), issuer(ro string), key_id(ro string), max_role(object), name(ro string), public_key(ro string)
DELETE /api/2.22/api-clients

Active Directory

GET /api/2.22/active-directory
POST /api/2.22/active-directory | Params: join_existing_account(boolean) | Body: computer_name(string), directory_servers(array), domain(string), encryption_types(array), fqdns(array), global_catalog_servers(array), join_ou(string), kerberos_servers(array), password(string), service_principal_names(array), user(string)
PATCH /api/2.22/active-directory | Body: directory_servers(array), encryption_types(array), fqdns(array), global_catalog_servers(array), join_ou(string), kerberos_servers(array), service_principal_names(array)
DELETE /api/2.22/active-directory | Params: local_only(boolean)
GET /api/2.22/active-directory/test

Administrators

GET /api/2.22/admins | Params: expose_api_token(boolean)
POST /api/2.22/admins | Body: management_access_policies(array), password(string), public_key(string), role(object)
PATCH /api/2.22/admins | Body: locked(boolean), old_password(string), password(string), public_key(string), role(object)
DELETE /api/2.22/admins
GET /api/2.22/admins/api-tokens | Params: admin_ids(array), admin_names(array), expose_api_token(boolean)
POST /api/2.22/admins/api-tokens | Params: admin_ids(array), admin_names(array), timeout(integer)
DELETE /api/2.22/admins/api-tokens | Params: admin_ids(array), admin_names(array)
GET /api/2.22/admins/cache | Params: refresh(boolean)
DELETE /api/2.22/admins/cache
GET /api/2.22/admins/settings
PATCH /api/2.22/admins/settings | Body: lockout_duration(integer), max_login_attempts(integer), min_password_length(integer)

Alert Watchers

GET /api/2.22/alert-watchers
POST /api/2.22/alert-watchers | Body: minimum_notification_severity(string)
PATCH /api/2.22/alert-watchers | Body: enabled(boolean), id(ro string), minimum_notification_severity(string), name(ro string)
DELETE /api/2.22/alert-watchers
GET /api/2.22/alert-watchers/test

Alerts

GET /api/2.22/alerts
PATCH /api/2.22/alerts | Body: action(ro string), code(ro integer), component_name(ro string), component_type(ro string), created(ro integer), description(ro string), duration(ro integer), flagged(boolean), id(ro string), index(ro integer), knowledge_base_url(ro string), name(ro string), notified(ro integer), severity(ro string), state(ro string), summary(ro string), updated(ro integer), variables(ro object)

Array Connections

GET /api/2.22/array-connections | Params: remote_ids(array), remote_names(array)
POST /api/2.22/array-connections | Body: ca_certificate_group(object), connection_key(string), context(ro object), encrypted(boolean), id(ro string), management_address(string), os(ro string), remote(object), replication_addresses(array), status(ro string), throttle(object), type(ro string), version(ro string)
PATCH /api/2.22/array-connections | Params: remote_ids(array), remote_names(array) | Body: ca_certificate_group(object), context(ro object), encrypted(boolean), id(ro string), management_address(string), os(ro string), remote(object), replication_addresses(array), status(ro string), throttle(object), type(ro string), version(ro string)
DELETE /api/2.22/array-connections | Params: remote_ids(array), remote_names(array)
GET /api/2.22/array-connections/connection-key
POST /api/2.22/array-connections/connection-key
GET /api/2.22/array-connections/path | Params: remote_ids(array), remote_names(array)
GET /api/2.22/array-connections/performance/replication | Params: end_time(integer), remote_ids(array), remote_names(array), resolution(integer), start_time(integer), total_only(boolean), type(string)

Arrays

GET /api/2.22/arrays
PATCH /api/2.22/arrays | Body: _as_of(ro integer), banner(string), context(ro object), default_inbound_tls_policy(object), encryption(ro object), eradication_config(object), id(ro string), idle_timeout(integer), name(string), network_access_policy(object), ntp_servers(array), os(ro string), product_type(ro string), revision(ro string), security_update(ro string), smb_mode(ro string), time_zone(string), version(ro string)
GET /api/2.22/arrays/erasures
POST /api/2.22/arrays/erasures | Params: eradicate_all_data(boolean*), preserve_configuration_data(string*), skip_phonehome_check(boolean*)
PATCH /api/2.22/arrays/erasures | Params: delete_sanitization_certificate(boolean*), eradicate_all_data(boolean*), finalize(boolean*)
DELETE /api/2.22/arrays/erasures
GET /api/2.22/arrays/eula
PATCH /api/2.22/arrays/eula | Body: agreement(ro string), signature(object)
GET /api/2.22/arrays/factory-reset-token
POST /api/2.22/arrays/factory-reset-token
DELETE /api/2.22/arrays/factory-reset-token
GET /api/2.22/arrays/http-specific-performance | Params: end_time(integer), resolution(integer), start_time(integer)
GET /api/2.22/arrays/nfs-specific-performance | Params: end_time(integer), resolution(integer), start_time(integer)
GET /api/2.22/arrays/performance | Params: end_time(integer), protocol(string), resolution(integer), start_time(integer)
GET /api/2.22/arrays/performance/replication | Params: end_time(integer), resolution(integer), start_time(integer), type(string)
GET /api/2.22/arrays/s3-specific-performance | Params: end_time(integer), resolution(integer), start_time(integer)
GET /api/2.22/arrays/space | Params: end_time(integer), resolution(integer), start_time(integer), type(string)
GET /api/2.22/arrays/space/storage-classes | Params: end_time(integer), resolution(integer), start_time(integer), storage_class_names(array), total_only(boolean)
GET /api/2.22/arrays/supported-time-zones

Audit Log Target for File Systems

GET /api/2.22/log-targets/file-systems
POST /api/2.22/log-targets/file-systems | Body: file_system(object), id(ro string), keep_for(integer), keep_size(integer), name(string)
PATCH /api/2.22/log-targets/file-systems | Body: file_system(object), id(ro string), keep_for(integer), keep_size(integer), name(string)
DELETE /api/2.22/log-targets/file-systems

Audit Log Target for Object Store

GET /api/2.22/log-targets/object-store
POST /api/2.22/log-targets/object-store | Body: bucket(object), id(ro string), log_name_prefix(object), log_rotate(object), name(string)
PATCH /api/2.22/log-targets/object-store | Body: bucket(object), id(ro string), log_name_prefix(object), log_rotate(object), name(string)
DELETE /api/2.22/log-targets/object-store

Audits

GET /api/2.22/audits

Authorization

GET /api/api_version
POST /api/login
GET /api/login-banner
POST /api/logout
POST /oauth2/1.0/token | Body: grant_type(string), subject_token(string), subject_token_type(string)

Blades

GET /api/2.22/blades | Params: total_only(boolean)

Bucket Replica Links

GET /api/2.22/bucket-replica-links | Params: local_bucket_ids(array), local_bucket_names(array), remote_bucket_names(array), remote_ids(array), remote_names(array), total_only(boolean)
POST /api/2.22/bucket-replica-links | Params: local_bucket_ids(array), local_bucket_names(array), remote_bucket_names(array), remote_credentials_ids(array), remote_credentials_names(array) | Body: cascading_enabled(boolean), paused(boolean)
PATCH /api/2.22/bucket-replica-links | Params: local_bucket_ids(array), local_bucket_names(array), remote_bucket_names(array), remote_ids(array), remote_names(array) | Body: cascading_enabled(ro boolean), context(ro object), direction(ro string), id(ro string), lag(ro integer), local_bucket(object), object_backlog(object), paused(boolean), recovery_point(ro integer), remote(object), remote_bucket(object), remote_credentials(object), status(ro string), status_details(ro string)
DELETE /api/2.22/bucket-replica-links | Params: local_bucket_ids(array), local_bucket_names(array), remote_bucket_names(array), remote_ids(array), remote_names(array)

Buckets

GET /api/2.22/bucket-audit-filter-actions
GET /api/2.22/buckets | Params: destroyed(boolean), total_only(boolean)
POST /api/2.22/buckets | Body: account(object), bucket_type(string), eradication_config(object), hard_limit_enabled(boolean), object_lock_config(object), quota_limit(string), retention_lock(string)
PATCH /api/2.22/buckets | Params: cancel_in_progress_storage_class_transition(boolean), ignore_usage(boolean) | Body: destroyed(boolean), eradication_config(object), hard_limit_enabled(boolean), object_lock_config(object), public_access_config(object), qos_policy(object), quota_limit(string), retention_lock(string), storage_class(object), versioning(string)
DELETE /api/2.22/buckets
GET /api/2.22/buckets/audit-filters | Params: bucket_ids(array), bucket_names(array)
POST /api/2.22/buckets/audit-filters | Params: bucket_ids(array), bucket_names(array) | Body: actions(array), s3_prefixes(array)
PATCH /api/2.22/buckets/audit-filters | Params: bucket_ids(array), bucket_names(array) | Body: actions(array), s3_prefixes(array)
DELETE /api/2.22/buckets/audit-filters | Params: bucket_ids(array), bucket_names(array)
GET /api/2.22/buckets/bucket-access-policies | Params: bucket_ids(array), bucket_names(array)
POST /api/2.22/buckets/bucket-access-policies | Params: bucket_ids(array), bucket_names(array) | Body: rules(array)
DELETE /api/2.22/buckets/bucket-access-policies | Params: bucket_ids(array), bucket_names(array)
GET /api/2.22/buckets/bucket-access-policies/rules | Params: bucket_ids(array), bucket_names(array)
POST /api/2.22/buckets/bucket-access-policies/rules | Params: bucket_ids(array), bucket_names(array) | Body: actions(array), effect(ro string), principals(object), resources(array)
DELETE /api/2.22/buckets/bucket-access-policies/rules | Params: bucket_ids(array), bucket_names(array)
GET /api/2.22/buckets/cross-origin-resource-sharing-policies | Params: bucket_ids(array), bucket_names(array)
POST /api/2.22/buckets/cross-origin-resource-sharing-policies | Params: bucket_ids(array), bucket_names(array) | Body: rules(array)
DELETE /api/2.22/buckets/cross-origin-resource-sharing-policies | Params: bucket_ids(array), bucket_names(array)
GET /api/2.22/buckets/cross-origin-resource-sharing-policies/rules | Params: bucket_ids(array), bucket_names(array)
POST /api/2.22/buckets/cross-origin-resource-sharing-policies/rules | Params: bucket_ids(array), bucket_names(array) | Body: allowed_headers(array), allowed_methods(array), allowed_origins(array)
DELETE /api/2.22/buckets/cross-origin-resource-sharing-policies/rules | Params: bucket_ids(array), bucket_names(array)
GET /api/2.22/buckets/performance | Params: end_time(integer), resolution(integer), start_time(integer), total_only(boolean)
GET /api/2.22/buckets/s3-specific-performance | Params: end_time(integer), resolution(integer), start_time(integer), total_only(boolean)

Certificate Groups

GET /api/2.22/certificate-groups
POST /api/2.22/certificate-groups
DELETE /api/2.22/certificate-groups
GET /api/2.22/certificate-groups/certificates | Params: certificate_group_ids(array), certificate_group_names(array), certificate_ids(array), certificate_names(array)
POST /api/2.22/certificate-groups/certificates | Params: certificate_group_ids(array), certificate_group_names(array), certificate_ids(array), certificate_names(array)
DELETE /api/2.22/certificate-groups/certificates | Params: certificate_group_ids(array), certificate_group_names(array), certificate_ids(array), certificate_names(array)
GET /api/2.22/certificate-groups/uses

Certificates

GET /api/2.22/certificates
POST /api/2.22/certificates | Body: certificate(string), certificate_type(string), common_name(string), country(string), days(integer), email(string), intermediate_certificate(string), issued_by(ro string), issued_to(ro string), key_algorithm(string), key_size(integer), locality(string), organization(string), organizational_unit(string), passphrase(string), private_key(string), realms(ro array), state(string), status(ro string), subject_alternative_names(array), valid_from(ro integer), valid_to(ro integer)
PATCH /api/2.22/certificates | Params: generate_new_key(boolean) | Body: certificate(string), certificate_type(string), common_name(string), country(string), days(integer), email(string), intermediate_certificate(string), issued_by(ro string), issued_to(ro string), key_algorithm(string), key_size(integer), locality(string), organization(string), organizational_unit(string), passphrase(string), private_key(string), realms(ro array), state(string), status(ro string), subject_alternative_names(array), valid_from(ro integer), valid_to(ro integer)
DELETE /api/2.22/certificates
GET /api/2.22/certificates/certificate-groups | Params: certificate_group_ids(array), certificate_group_names(array), certificate_ids(array), certificate_names(array)
POST /api/2.22/certificates/certificate-groups | Params: certificate_group_ids(array), certificate_group_names(array), certificate_ids(array), certificate_names(array)
DELETE /api/2.22/certificates/certificate-groups | Params: certificate_group_ids(array), certificate_group_names(array), certificate_ids(array), certificate_names(array)
POST /api/2.22/certificates/certificate-signing-requests | Body: certificate(object), common_name(string), country(string), email(string), locality(string), organization(string), organizational_unit(string), state(string), subject_alternative_names(array)
GET /api/2.22/certificates/uses

Clients

GET /api/2.22/arrays/clients/performance | Params: protocol(string), total_only(boolean)
GET /api/2.22/arrays/clients/s3-specific-performance | Params: total_only(boolean)

DNS

GET /api/2.22/dns
POST /api/2.22/dns | Body: domain(string), nameservers(array), services(array), sources(array)
PATCH /api/2.22/dns | Body: domain(string), id(ro string), name(string), nameservers(array), realms(ro array), services(array), sources(array)
DELETE /api/2.22/dns

Directory Services

GET /api/2.22/directory-services
PATCH /api/2.22/directory-services | Body: base_dn(string), bind_password(string), bind_user(string), ca_certificate(object), ca_certificate_group(object), enabled(boolean), id(ro string), management(object), name(ro string), nfs(object), services(ro array), smb(object), uris(array)
GET /api/2.22/directory-services/roles | Params: role_ids(array), role_names(array)
POST /api/2.22/directory-services/roles | Body: group(string), group_base(string), management_access_policies(array), role(object)
PATCH /api/2.22/directory-services/roles | Params: role_ids(array), role_names(array) | Body: group(string), group_base(string), id(ro string), management_access_policies(ro array), name(ro string), role(object)
DELETE /api/2.22/directory-services/roles
GET /api/2.22/directory-services/test
PATCH /api/2.22/directory-services/test | Body: base_dn(string), bind_password(string), bind_user(string), ca_certificate(object), ca_certificate_group(object), enabled(boolean), id(ro string), management(object), name(ro string), nfs(object), services(ro array), smb(object), uris(array)

Drives

GET /api/2.22/drives | Params: total_only(boolean)

File System Exports

GET /api/2.22/file-system-exports
POST /api/2.22/file-system-exports | Body: export_name(string), server(object), share_policy(object)
PATCH /api/2.22/file-system-exports | Body: context(ro object), enabled(ro boolean), export_name(string), id(ro string), member(object), name(ro string), policy(object), policy_type(ro string), server(object), share_policy(object), status(ro string)
DELETE /api/2.22/file-system-exports

File System Replica Links

GET /api/2.22/file-system-replica-links | Params: local_file_system_ids(array), local_file_system_names(array), remote_file_system_ids(array), remote_file_system_names(array), remote_ids(array), remote_names(array)
POST /api/2.22/file-system-replica-links | Params: local_file_system_ids(array), local_file_system_names(array), remote_file_system_names(array), remote_ids(array), remote_names(array) | Body: context(ro object), direction(ro string), id(ro string), lag(ro integer), link_type(string), local_file_system(object), policies(array), recovery_point(ro integer), remote(object), remote_file_system(object), status(ro string), status_details(ro string)
PATCH /api/2.22/file-system-replica-links | Params: local_file_system_ids(array), local_file_system_names(array), remote_ids(array), remote_names(array), replicate_now(boolean)
DELETE /api/2.22/file-system-replica-links | Params: cancel_in_progress_transfers(boolean), local_file_system_ids(array), local_file_system_names(array), remote_file_system_ids(array), remote_file_system_names(array), remote_ids(array), remote_names(array)
GET /api/2.22/file-system-replica-links/policies | Params: local_file_system_ids(array), local_file_system_names(array), remote_file_system_ids(array), remote_file_system_names(array), remote_ids(array), remote_names(array)
POST /api/2.22/file-system-replica-links/policies | Params: local_file_system_ids(array), local_file_system_names(array), remote_ids(array), remote_names(array)
DELETE /api/2.22/file-system-replica-links/policies | Params: local_file_system_ids(array), local_file_system_names(array), remote_ids(array), remote_names(array)
GET /api/2.22/file-system-replica-links/transfer | Params: names_or_owner_names(array), remote_ids(array), remote_names(array), total_only(boolean)

File System Snapshots

GET /api/2.22/file-system-snapshots | Params: destroyed(boolean), names_or_owner_names(array), owner_ids(array), total_only(boolean)
POST /api/2.22/file-system-snapshots | Params: send(boolean), source_ids(array), source_names(array), targets(array) | Body: suffix(string)
PATCH /api/2.22/file-system-snapshots | Params: latest_replica(boolean) | Body: context(ro object), created(ro integer), destroyed(boolean), id(ro string), name(string), owner(object), owner_destroyed(ro boolean), policies(ro array), policy(object), source(object), suffix(ro string), time_remaining(ro integer)
DELETE /api/2.22/file-system-snapshots
GET /api/2.22/file-system-snapshots/policies
DELETE /api/2.22/file-system-snapshots/policies
GET /api/2.22/file-system-snapshots/transfer | Params: names_or_owner_names(array), total_only(boolean)
DELETE /api/2.22/file-system-snapshots/transfer | Params: remote_ids(array), remote_names(array)

File Systems

GET /api/2.22/file-systems | Params: destroyed(boolean), total_only(boolean)
POST /api/2.22/file-systems | Params: default_exports(array), discard_non_snapshotted_data(boolean), overwrite(boolean) | Body: default_group_quota(integer), default_user_quota(integer), eradication_config(object), fast_remove_directory_enabled(boolean), group_ownership(string), hard_limit_enabled(boolean), http(object), multi_protocol(object), nfs(object), node_group(object), provisioned(integer), qos_policy(object), requested_promotion_state(ro string), smb(object), snapshot_directory_enabled(boolean), source(object), writable(boolean)
PATCH /api/2.22/file-systems | Params: cancel_in_progress_storage_class_transition(boolean), delete_link_on_eradication(boolean), discard_detailed_permissions(boolean), discard_non_snapshotted_data(boolean), ignore_usage(boolean) | Body: created(ro integer), default_group_quota(integer), default_user_quota(integer), destroyed(boolean), fast_remove_directory_enabled(boolean), group_ownership(string), hard_limit_enabled(boolean), http(object), id(ro string), multi_protocol(object), name(string), nfs(object), promotion_status(ro string), provisioned(integer), qos_policy(object), requested_promotion_state(string), smb(object), snapshot_directory_enabled(boolean), source(object), storage_class(object), time_remaining(ro integer), writable(boolean)
DELETE /api/2.22/file-systems
GET /api/2.22/file-systems/audit-policies
POST /api/2.22/file-systems/audit-policies
DELETE /api/2.22/file-systems/audit-policies
GET /api/2.22/file-systems/data-eviction-policies
POST /api/2.22/file-systems/data-eviction-policies
DELETE /api/2.22/file-systems/data-eviction-policies
GET /api/2.22/file-systems/groups/performance | Params: file_system_ids(array), file_system_names(array), gids(array), group_names(array), total_only(boolean)
GET /api/2.22/file-systems/locks | Params: client_names(array), file_system_ids(array), file_system_names(array), inodes(array), paths(array)
DELETE /api/2.22/file-systems/locks | Params: client_names(array), file_system_ids(array), file_system_names(array), inodes(array), paths(array), recursive(boolean)
GET /api/2.22/file-systems/locks/clients
POST /api/2.22/file-systems/locks/nlm-reclamations
GET /api/2.22/file-systems/open-files | Params: client_names(array), file_system_ids(array), file_system_names(array), paths(array), protocols(array*), session_names(array), user_names(array)
DELETE /api/2.22/file-systems/open-files
GET /api/2.22/file-systems/performance | Params: end_time(integer), protocol(string), resolution(integer), start_time(integer), total_only(boolean)
GET /api/2.22/file-systems/policies
POST /api/2.22/file-systems/policies
DELETE /api/2.22/file-systems/policies
GET /api/2.22/file-systems/policies-all
GET /api/2.22/file-systems/sessions | Params: client_names(array), protocols(array), user_names(array)
DELETE /api/2.22/file-systems/sessions | Params: client_names(array), disruptive(boolean), protocols(array), user_names(array)
GET /api/2.22/file-systems/space/storage-classes | Params: storage_class_names(array), total_only(boolean)
GET /api/2.22/file-systems/users/performance | Params: file_system_ids(array), file_system_names(array), total_only(boolean), uids(array), user_names(array)
GET /api/2.22/file-systems/worm-data-policies

Fleets

GET /api/2.22/fleets | Params: total_only(boolean)
POST /api/2.22/fleets
PATCH /api/2.22/fleets | Body: name(string)
DELETE /api/2.22/fleets
GET /api/2.22/fleets/fleet-key | Params: total_only(boolean)
POST /api/2.22/fleets/fleet-key
GET /api/2.22/fleets/members | Params: fleet_ids(array), fleet_names(array), total_only(boolean)
POST /api/2.22/fleets/members | Params: fleet_ids(array), fleet_names(array) | Body: members(array)
DELETE /api/2.22/fleets/members | Params: unreachable(boolean)

Hardware

GET /api/2.22/hardware
PATCH /api/2.22/hardware | Body: data_mac(ro string), details(ro string), id(ro string), identify_enabled(boolean), index(ro integer), management_mac(ro string), model(ro string), name(ro string), part_number(ro string), sensor_readings(ro array), serial(ro string), slot(ro integer), speed(ro integer), status(ro string), temperature(ro integer), type(ro string)

Hardware Connectors

GET /api/2.22/hardware-connectors
PATCH /api/2.22/hardware-connectors | Body: connector_type(ro string), id(ro string), lane_speed(integer), lanes_per_port(integer), name(ro string), port_count(integer), port_speed(integer), transceiver_type(ro string)
GET /api/2.22/hardware-connectors/performance | Params: end_time(integer), resolution(integer), start_time(integer), total_only(boolean)

KMIP

GET /api/2.22/kmip
POST /api/2.22/kmip | Body: ca_certificate(object), ca_certificate_group(object), id(ro string), name(ro string), uris(array)
PATCH /api/2.22/kmip | Body: ca_certificate(object), ca_certificate_group(object), id(ro string), name(ro string), uris(array)
DELETE /api/2.22/kmip
GET /api/2.22/kmip/test

Keytabs

GET /api/2.22/keytabs
POST /api/2.22/keytabs | Params: name_prefixes(string) | Body: source(object)
DELETE /api/2.22/keytabs
GET /api/2.22/keytabs/download | Params: keytab_ids(array), keytab_names(array)
POST /api/2.22/keytabs/upload | Params: name_prefixes(string) | Body: keytab_file(string)

Legal Holds

GET /api/2.22/legal-holds
POST /api/2.22/legal-holds | Body: description(string), id(ro string), name(ro string), realms(ro array)
PATCH /api/2.22/legal-holds | Body: description(string), id(ro string), name(ro string), realms(ro array)
DELETE /api/2.22/legal-holds
GET /api/2.22/legal-holds/held-entities | Params: file_system_ids(array), file_system_names(array), paths(array)
POST /api/2.22/legal-holds/held-entities | Params: file_system_ids(array), file_system_names(array), paths(array), recursive(boolean)
PATCH /api/2.22/legal-holds/held-entities | Params: file_system_ids(array), file_system_names(array), paths(array), recursive(boolean), released(boolean*)

Lifecycle Rules

GET /api/2.22/lifecycle-rules | Params: bucket_ids(array), bucket_names(array)
POST /api/2.22/lifecycle-rules | Params: confirm_date(boolean) | Body: abort_incomplete_multipart_uploads_after(integer), bucket(object), keep_current_version_for(integer), keep_current_version_until(integer), keep_previous_version_for(integer), prefix(string), rule_id(string)
PATCH /api/2.22/lifecycle-rules | Params: bucket_ids(array), bucket_names(array), confirm_date(boolean) | Body: abort_incomplete_multipart_uploads_after(integer), enabled(boolean), keep_current_version_for(integer), keep_current_version_until(integer), keep_previous_version_for(integer), prefix(string)
DELETE /api/2.22/lifecycle-rules | Params: bucket_ids(array), bucket_names(array)

Link Aggregation Groups

GET /api/2.22/link-aggregation-groups
POST /api/2.22/link-aggregation-groups | Body: id(ro string), lag_speed(ro integer), mac_address(ro string), name(ro string), port_speed(ro integer), ports(array), status(ro string)
PATCH /api/2.22/link-aggregation-groups | Body: add_ports(array), ports(array), remove_ports(array)
DELETE /api/2.22/link-aggregation-groups

Logs

GET /api/2.22/logs | Params: end_time(integer), start_time(integer)
GET /api/2.22/logs-async
PATCH /api/2.22/logs-async | Body: available_files(ro array), end_time(integer), hardware_components(array), id(ro string), last_request_time(ro integer), name(ro string), processing(ro boolean), progress(ro number), start_time(integer)
GET /api/2.22/logs-async/download

Maintenance Windows

GET /api/2.22/maintenance-windows
POST /api/2.22/maintenance-windows | Body: timeout(integer)
DELETE /api/2.22/maintenance-windows

Network Interfaces

GET /api/2.22/network-interfaces
POST /api/2.22/network-interfaces | Body: address(string), attached_servers(array), enabled(ro boolean), gateway(ro string), id(ro string), mtu(ro integer), name(ro string), netmask(ro string), realms(ro array), services(array), subnet(object), type(string), vlan(ro integer)
PATCH /api/2.22/network-interfaces | Body: address(string), attached_servers(array), services(array)
DELETE /api/2.22/network-interfaces
GET /api/2.22/network-interfaces/connectors
PATCH /api/2.22/network-interfaces/connectors | Body: connector_type(ro string), id(ro string), lane_speed(integer), lanes_per_port(integer), name(ro string), port_count(integer), port_speed(integer), transceiver_type(ro string)
GET /api/2.22/network-interfaces/connectors/performance | Params: end_time(integer), resolution(integer), start_time(integer), total_only(boolean)
GET /api/2.22/network-interfaces/connectors/settings
GET /api/2.22/network-interfaces/neighbors | Params: local_port_names(array), total_item_count(boolean)
GET /api/2.22/network-interfaces/network-connection-statistics | Params: current_state(array), local_host(array), local_port(array), remote_host(array), remote_port(array)
GET /api/2.22/network-interfaces/ping | Params: component_name(string), count(integer), destination(string*), packet_size(integer), print_latency(boolean), resolve_hostname(boolean), source(string)
GET /api/2.22/network-interfaces/trace | Params: component_name(string), destination(string*), discover_mtu(boolean), fragment_packet(boolean), method(string), port(string), resolve_hostname(boolean), source(string)

Node Groups

GET /api/2.22/node-groups
POST /api/2.22/node-groups
PATCH /api/2.22/node-groups | Body: name(string)
DELETE /api/2.22/node-groups
GET /api/2.22/node-groups/nodes | Params: node_group_ids(array), node_group_names(array), node_ids(array), node_names(array)
POST /api/2.22/node-groups/nodes | Params: node_group_ids(array), node_group_names(array), node_ids(array), node_names(array)
DELETE /api/2.22/node-groups/nodes | Params: node_group_ids(array), node_group_names(array), node_ids(array), node_names(array)
GET /api/2.22/node-groups/uses

Nodes

GET /api/2.22/nodes | Params: total_only(boolean)
PATCH /api/2.22/nodes | Body: capacity(ro integer), data_addresses(ro array), details(ro string), id(ro string), management_address(string), name(string), raw_capacity(ro integer), serial_number(string), status(ro string), unique(ro integer)
POST /api/2.22/nodes/batch

OIDC SSO

GET /api/2.22/sso/oidc/idps
POST /api/2.22/sso/oidc/idps | Body: enabled(boolean), idp(object), prn(ro string), services(array)
PATCH /api/2.22/sso/oidc/idps | Body: enabled(boolean), idp(object), name(string), prn(ro string), services(array)
DELETE /api/2.22/sso/oidc/idps

Object Store Access Keys

GET /api/2.22/object-store-access-keys
POST /api/2.22/object-store-access-keys | Body: secret_access_key(string), user(object)
PATCH /api/2.22/object-store-access-keys | Body: access_key_id(ro string), context(ro object), created(ro integer), enabled(boolean), name(ro string), secret_access_key(ro string), user(ro object)
DELETE /api/2.22/object-store-access-keys

Object Store Account Exports

GET /api/2.22/object-store-account-exports
POST /api/2.22/object-store-account-exports | Body: export_enabled(boolean), server(object)
PATCH /api/2.22/object-store-account-exports | Body: export_enabled(boolean), policy(object)
DELETE /api/2.22/object-store-account-exports

Object Store Accounts

GET /api/2.22/object-store-accounts | Params: total_only(boolean)
POST /api/2.22/object-store-accounts | Body: account_exports(array), bucket_defaults(object), hard_limit_enabled(boolean), quota_limit(string)
PATCH /api/2.22/object-store-accounts | Params: ignore_usage(boolean) | Body: bucket_defaults(object), hard_limit_enabled(boolean), public_access_config(object), quota_limit(string)
DELETE /api/2.22/object-store-accounts

Object Store Remote Credentials

GET /api/2.22/object-store-remote-credentials
POST /api/2.22/object-store-remote-credentials | Body: access_key_id(string), secret_access_key(string)
PATCH /api/2.22/object-store-remote-credentials | Body: access_key_id(string), context(ro object), id(ro string), name(string), realms(ro array), remote(object), secret_access_key(string)
DELETE /api/2.22/object-store-remote-credentials

Object Store Roles

GET /api/2.22/object-store-roles
POST /api/2.22/object-store-roles | Body: max_session_duration(integer)
PATCH /api/2.22/object-store-roles | Body: account(object), context(ro object), created(ro integer), id(ro string), max_session_duration(integer), name(ro string), prn(ro string), trusted_entities(ro array)
DELETE /api/2.22/object-store-roles
GET /api/2.22/object-store-roles/object-store-access-policies
POST /api/2.22/object-store-roles/object-store-access-policies
DELETE /api/2.22/object-store-roles/object-store-access-policies
GET /api/2.22/object-store-roles/object-store-trust-policies | Params: role_ids(array), role_names(array)
GET /api/2.22/object-store-roles/object-store-trust-policies/download | Params: role_ids(array), role_names(array)
GET /api/2.22/object-store-roles/object-store-trust-policies/rules | Params: indices(array), role_ids(array), role_names(array)
POST /api/2.22/object-store-roles/object-store-trust-policies/rules | Params: role_ids(array), role_names(array) | Body: actions(array), conditions(array), effect(ro string), policy(object), principals(array)
PATCH /api/2.22/object-store-roles/object-store-trust-policies/rules | Params: indices(array), role_ids(array), role_names(array) | Body: actions(array), conditions(array), effect(ro string), policy(object), principals(array)
DELETE /api/2.22/object-store-roles/object-store-trust-policies/rules | Params: indices(array), role_ids(array), role_names(array)
PATCH /api/2.22/object-store-roles/object-store-trust-policies/upload | Params: role_ids(array), role_names(array)

Object Store Users

GET /api/2.22/object-store-users
POST /api/2.22/object-store-users | Params: full_access(boolean)
DELETE /api/2.22/object-store-users
GET /api/2.22/object-store-users/object-store-access-policies
POST /api/2.22/object-store-users/object-store-access-policies
DELETE /api/2.22/object-store-users/object-store-access-policies

Object Store Virtual Hosts

GET /api/2.22/object-store-virtual-hosts
POST /api/2.22/object-store-virtual-hosts | Body: attached_servers(array), context(ro object), hostname(string), id(ro string), name(ro string), realms(ro array)
PATCH /api/2.22/object-store-virtual-hosts | Body: add_attached_servers(array), attached_servers(array), hostname(string), id(ro string), name(string), remove_attached_servers(array)
DELETE /api/2.22/object-store-virtual-hosts

Policies (All)

GET /api/2.22/policies-all
GET /api/2.22/policies-all/members | Params: local_file_system_ids(array), local_file_system_names(array), member_types(array), remote_file_system_ids(array), remote_file_system_names(array), remote_ids(array), remote_names(array)

Policies - Audit for File Systems

GET /api/2.22/audit-file-systems-policies
POST /api/2.22/audit-file-systems-policies | Body: control_type(string), enabled(boolean), id(ro string), is_local(ro boolean), location(object), log_targets(array), name(string), policy_type(ro string), realms(ro array), rules(array)
PATCH /api/2.22/audit-file-systems-policies | Body: add_log_targets(array), enabled(boolean), id(ro string), is_local(ro boolean), location(object), log_targets(array), name(string), policy_type(ro string), realms(ro array), remove_log_targets(array), rules(array)
DELETE /api/2.22/audit-file-systems-policies
GET /api/2.22/audit-file-systems-policies/members
POST /api/2.22/audit-file-systems-policies/members
DELETE /api/2.22/audit-file-systems-policies/members
GET /api/2.22/audit-file-systems-policy-operations

Policies - Audit for Object Store

GET /api/2.22/audit-object-store-policies
POST /api/2.22/audit-object-store-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), log_targets(array), name(string), policy_type(ro string), realms(ro array)
PATCH /api/2.22/audit-object-store-policies | Body: add_log_targets(array), enabled(boolean), id(ro string), is_local(ro boolean), location(object), log_targets(array), name(string), policy_type(ro string), realms(ro array), remove_log_targets(array)
DELETE /api/2.22/audit-object-store-policies
GET /api/2.22/audit-object-store-policies/members
POST /api/2.22/audit-object-store-policies/members
DELETE /api/2.22/audit-object-store-policies/members

Policies - Data Eviction

GET /api/2.22/data-eviction-policies
POST /api/2.22/data-eviction-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), keep_size(integer), location(object), name(string), policy_type(ro string), realms(ro array)
PATCH /api/2.22/data-eviction-policies | Body: context(ro object), enabled(boolean), id(ro string), is_local(ro boolean), keep_size(integer), location(object), name(string), policy_type(ro string), realms(ro array)
DELETE /api/2.22/data-eviction-policies
GET /api/2.22/data-eviction-policies/file-systems
POST /api/2.22/data-eviction-policies/file-systems
DELETE /api/2.22/data-eviction-policies/file-systems
GET /api/2.22/data-eviction-policies/members

Policies - Management Access

GET /api/2.22/admins/management-access-policies
POST /api/2.22/admins/management-access-policies
DELETE /api/2.22/admins/management-access-policies
GET /api/2.22/directory-services/roles/management-access-policies
POST /api/2.22/directory-services/roles/management-access-policies
DELETE /api/2.22/directory-services/roles/management-access-policies
GET /api/2.22/management-access-policies
POST /api/2.22/management-access-policies | Body: aggregation_strategy(string), enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), rules(array)
PATCH /api/2.22/management-access-policies | Body: aggregation_strategy(string), enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), rules(array), version(ro string)
DELETE /api/2.22/management-access-policies
GET /api/2.22/management-access-policies/admins
POST /api/2.22/management-access-policies/admins
DELETE /api/2.22/management-access-policies/admins
GET /api/2.22/management-access-policies/directory-services/roles
POST /api/2.22/management-access-policies/directory-services/roles
DELETE /api/2.22/management-access-policies/directory-services/roles
GET /api/2.22/management-access-policies/members

Policies - Management Authentication

GET /api/2.22/admins/management-authentication-policies
POST /api/2.22/admins/management-authentication-policies
DELETE /api/2.22/admins/management-authentication-policies
GET /api/2.22/arrays/management-authentication-policies
POST /api/2.22/arrays/management-authentication-policies
DELETE /api/2.22/arrays/management-authentication-policies
GET /api/2.22/management-authentication-policies
POST /api/2.22/management-authentication-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), ssh(object)
PATCH /api/2.22/management-authentication-policies | Body: context(ro object), enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), ssh(object)
DELETE /api/2.22/management-authentication-policies
GET /api/2.22/management-authentication-policies/members | Params: member_types(array)
POST /api/2.22/management-authentication-policies/members | Params: member_types(array)
DELETE /api/2.22/management-authentication-policies/members | Params: member_types(array)

Policies - NFS

GET /api/2.22/nfs-export-policies
POST /api/2.22/nfs-export-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), rules(array)
PATCH /api/2.22/nfs-export-policies | Params: versions(array) | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), rules(array), version(ro string)
DELETE /api/2.22/nfs-export-policies | Params: versions(array)
GET /api/2.22/nfs-export-policies/rules
POST /api/2.22/nfs-export-policies/rules | Params: before_rule_id(string), before_rule_name(string), versions(array) | Body: access(string), anongid(integer), anonuid(integer), atime(boolean), client(string), context(ro object), fileid_32bit(boolean), id(ro string), index(integer), name(ro string), permission(string), policy(object), policy_version(ro string), required_transport_security(string), secure(boolean), security(array)
PATCH /api/2.22/nfs-export-policies/rules | Params: before_rule_id(string), before_rule_name(string), versions(array) | Body: access(string), anongid(string), anonuid(string), atime(boolean), client(string), fileid_32bit(boolean), id(ro string), index(integer), name(ro string), permission(string), required_transport_security(string), secure(boolean), security(array)
DELETE /api/2.22/nfs-export-policies/rules | Params: versions(array)

Policies - Network Access

GET /api/2.22/network-access-policies
PATCH /api/2.22/network-access-policies | Params: versions(array) | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), rules(array), version(ro string)
GET /api/2.22/network-access-policies/members
GET /api/2.22/network-access-policies/rules
POST /api/2.22/network-access-policies/rules | Params: before_rule_id(string), before_rule_name(string), versions(array) | Body: client(string), effect(string), id(ro string), index(integer), interfaces(array), name(ro string)
PATCH /api/2.22/network-access-policies/rules | Params: before_rule_id(string), before_rule_name(string), versions(array) | Body: client(string), effect(string), id(ro string), index(integer), interfaces(array), name(ro string), policy(object), policy_version(ro string)
DELETE /api/2.22/network-access-policies/rules | Params: versions(array)

Policies - Object Store Access

GET /api/2.22/object-store-access-policies | Params: exclude_rules(boolean)
POST /api/2.22/object-store-access-policies | Params: enforce_action_restrictions(boolean) | Body: description(string), rules(array)
PATCH /api/2.22/object-store-access-policies | Params: enforce_action_restrictions(boolean) | Body: rules(array)
DELETE /api/2.22/object-store-access-policies
GET /api/2.22/object-store-access-policies/object-store-roles
POST /api/2.22/object-store-access-policies/object-store-roles
DELETE /api/2.22/object-store-access-policies/object-store-roles
GET /api/2.22/object-store-access-policies/object-store-users
POST /api/2.22/object-store-access-policies/object-store-users
DELETE /api/2.22/object-store-access-policies/object-store-users
GET /api/2.22/object-store-access-policies/rules
POST /api/2.22/object-store-access-policies/rules | Params: enforce_action_restrictions(boolean) | Body: actions(array), conditions(object), effect(string), resources(array)
PATCH /api/2.22/object-store-access-policies/rules | Params: enforce_action_restrictions(boolean) | Body: actions(array), conditions(object), effect(string), resources(array)
DELETE /api/2.22/object-store-access-policies/rules
GET /api/2.22/object-store-access-policy-actions

Policies - Password

GET /api/2.22/password-policies
PATCH /api/2.22/password-policies | Body: enabled(boolean), enforce_dictionary_check(boolean), enforce_username_check(boolean), id(ro string), is_local(ro boolean), location(object), lockout_duration(integer), max_login_attempts(integer), max_password_age(integer), min_character_groups(integer), min_characters_per_group(integer), min_password_age(integer), min_password_length(integer), name(string), password_history(integer), policy_type(ro string), realms(ro array)

Policies - QoS

GET /api/2.22/qos-policies
POST /api/2.22/qos-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), max_total_bytes_per_sec(integer), max_total_ops_per_sec(integer), name(string), policy_type(ro string), realms(ro array)
PATCH /api/2.22/qos-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), max_total_bytes_per_sec(integer), max_total_ops_per_sec(integer), name(string), policy_type(ro string), realms(ro array)
DELETE /api/2.22/qos-policies
GET /api/2.22/qos-policies/buckets
GET /api/2.22/qos-policies/file-systems
GET /api/2.22/qos-policies/members | Params: member_types(array)
POST /api/2.22/qos-policies/members | Params: member_types(array)
DELETE /api/2.22/qos-policies/members | Params: member_types(array)

Policies - S3 Export

GET /api/2.22/s3-export-policies
POST /api/2.22/s3-export-policies | Body: enabled(boolean), rules(array)
PATCH /api/2.22/s3-export-policies | Body: enabled(boolean), name(string), rules(array)
DELETE /api/2.22/s3-export-policies
GET /api/2.22/s3-export-policies/rules
POST /api/2.22/s3-export-policies/rules | Body: actions(array), effect(string), resources(array)
PATCH /api/2.22/s3-export-policies/rules | Body: actions(array), effect(string), resources(array)
DELETE /api/2.22/s3-export-policies/rules

Policies - SMB Client

GET /api/2.22/smb-client-policies
POST /api/2.22/smb-client-policies | Body: access_based_enumeration_enabled(boolean), enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), rules(array)
PATCH /api/2.22/smb-client-policies | Body: access_based_enumeration_enabled(boolean), enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), rules(array), version(ro string)
DELETE /api/2.22/smb-client-policies
GET /api/2.22/smb-client-policies/rules
POST /api/2.22/smb-client-policies/rules | Params: before_rule_id(string), before_rule_name(string), versions(array) | Body: client(string), encryption(string), id(ro string), index(integer), name(ro string), permission(string)
PATCH /api/2.22/smb-client-policies/rules | Params: before_rule_id(string), before_rule_name(string), versions(array) | Body: client(string), context(ro object), encryption(string), id(ro string), index(integer), name(ro string), permission(string), policy(object), policy_version(ro string)
DELETE /api/2.22/smb-client-policies/rules | Params: versions(array)

Policies - SMB Share

GET /api/2.22/smb-share-policies
POST /api/2.22/smb-share-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), rules(array)
PATCH /api/2.22/smb-share-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), rules(array)
DELETE /api/2.22/smb-share-policies
GET /api/2.22/smb-share-policies/rules
POST /api/2.22/smb-share-policies/rules | Body: change(string), full_control(string), id(ro string), name(ro string), principal(string), read(string)
PATCH /api/2.22/smb-share-policies/rules | Body: change(string), full_control(string), id(ro string), name(ro string), policy(object), principal(string), read(string)
DELETE /api/2.22/smb-share-policies/rules

Policies - SSH Certificate Authority

GET /api/2.22/admins/ssh-certificate-authority-policies
POST /api/2.22/admins/ssh-certificate-authority-policies
DELETE /api/2.22/admins/ssh-certificate-authority-policies
GET /api/2.22/arrays/ssh-certificate-authority-policies
POST /api/2.22/arrays/ssh-certificate-authority-policies
DELETE /api/2.22/arrays/ssh-certificate-authority-policies
GET /api/2.22/ssh-certificate-authority-policies
POST /api/2.22/ssh-certificate-authority-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), signing_authority(object), static_authorized_principals(array)
PATCH /api/2.22/ssh-certificate-authority-policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), signing_authority(object), static_authorized_principals(array)
DELETE /api/2.22/ssh-certificate-authority-policies
GET /api/2.22/ssh-certificate-authority-policies/admins
POST /api/2.22/ssh-certificate-authority-policies/admins
DELETE /api/2.22/ssh-certificate-authority-policies/admins
GET /api/2.22/ssh-certificate-authority-policies/arrays
POST /api/2.22/ssh-certificate-authority-policies/arrays
DELETE /api/2.22/ssh-certificate-authority-policies/arrays
GET /api/2.22/ssh-certificate-authority-policies/members

Policies - Snapshot

GET /api/2.22/policies
POST /api/2.22/policies | Body: enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), retention_lock(ro string), rules(array)
PATCH /api/2.22/policies | Params: destroy_snapshots(boolean) | Body: add_rules(array), enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(ro string), policy_type(ro string), realms(ro array), remove_rules(array), retention_lock(ro string), rules(array)
DELETE /api/2.22/policies
GET /api/2.22/policies/file-system-replica-links | Params: local_file_system_ids(array), local_file_system_names(array), remote_file_system_ids(array), remote_file_system_names(array), remote_ids(array), remote_names(array)
POST /api/2.22/policies/file-system-replica-links | Params: local_file_system_ids(array), local_file_system_names(array), remote_ids(array), remote_names(array)
DELETE /api/2.22/policies/file-system-replica-links | Params: local_file_system_ids(array), local_file_system_names(array), remote_ids(array), remote_names(array)
GET /api/2.22/policies/file-system-snapshots
DELETE /api/2.22/policies/file-system-snapshots
GET /api/2.22/policies/file-systems
POST /api/2.22/policies/file-systems
DELETE /api/2.22/policies/file-systems
GET /api/2.22/policies/members | Params: local_file_system_ids(array), local_file_system_names(array), member_types(array), remote_file_system_ids(array), remote_file_system_names(array), remote_ids(array), remote_names(array)

Policies - Storage Class Tiering

GET /api/2.22/storage-class-tiering-policies
POST /api/2.22/storage-class-tiering-policies | Body: archival_rules(array), enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), retrieval_rules(array)
PATCH /api/2.22/storage-class-tiering-policies | Body: archival_rules(array), enabled(boolean), id(ro string), is_local(ro boolean), location(object), name(string), policy_type(ro string), realms(ro array), retrieval_rules(array)
DELETE /api/2.22/storage-class-tiering-policies
GET /api/2.22/storage-class-tiering-policies/members

Policies - TLS

GET /api/2.22/network-interfaces/tls-policies
POST /api/2.22/network-interfaces/tls-policies
DELETE /api/2.22/network-interfaces/tls-policies
GET /api/2.22/tls-policies | Params: effective(boolean), purity_defined(boolean)
POST /api/2.22/tls-policies | Body: appliance_certificate(object), client_certificates_required(boolean), disabled_tls_ciphers(array), enabled(boolean), enabled_tls_ciphers(array), id(ro string), is_local(ro boolean), location(object), min_tls_version(string), name(string), policy_type(ro string), realms(ro array), trusted_client_certificate_authority(object), verify_client_certificate_trust(boolean)
PATCH /api/2.22/tls-policies | Body: appliance_certificate(object), client_certificates_required(boolean), disabled_tls_ciphers(array), enabled(boolean), enabled_tls_ciphers(array), id(ro string), is_local(ro boolean), location(object), min_tls_version(string), name(string), policy_type(ro string), realms(ro array), trusted_client_certificate_authority(object), verify_client_certificate_trust(boolean)
DELETE /api/2.22/tls-policies
GET /api/2.22/tls-policies/members
GET /api/2.22/tls-policies/network-interfaces
POST /api/2.22/tls-policies/network-interfaces
DELETE /api/2.22/tls-policies/network-interfaces

Policies - WORM Data

GET /api/2.22/worm-data-policies
POST /api/2.22/worm-data-policies | Body: context(ro object), default_retention(integer), enabled(boolean), id(ro string), is_local(ro boolean), location(object), max_retention(integer), min_retention(integer), mode(string), name(ro string), policy_type(ro string), realms(ro array), retention_lock(string)
PATCH /api/2.22/worm-data-policies | Body: context(ro object), default_retention(integer), enabled(boolean), id(ro string), is_local(ro boolean), location(object), max_retention(integer), min_retention(integer), mode(string), name(ro string), policy_type(ro string), realms(ro array), retention_lock(string)
DELETE /api/2.22/worm-data-policies
GET /api/2.22/worm-data-policies/members

Public Keys

GET /api/2.22/public-keys
POST /api/2.22/public-keys | Body: public_key(string)
DELETE /api/2.22/public-keys
GET /api/2.22/public-keys/uses

Quotas

GET /api/2.22/quotas/groups | Params: file_system_ids(array), file_system_names(array), gids(array), group_names(array)
POST /api/2.22/quotas/groups | Params: file_system_ids(array), file_system_names(array), gids(array), group_names(array) | Body: name(ro string), quota(integer)
PATCH /api/2.22/quotas/groups | Params: file_system_ids(array), file_system_names(array), gids(array), group_names(array) | Body: name(ro string), quota(integer)
DELETE /api/2.22/quotas/groups | Params: file_system_ids(array), file_system_names(array), gids(array), group_names(array)
GET /api/2.22/quotas/settings
PATCH /api/2.22/quotas/settings | Body: contact(string), direct_notifications_enabled(boolean), id(ro string), name(ro string)
GET /api/2.22/quotas/users | Params: file_system_ids(array), file_system_names(array), uids(array), user_names(array)
POST /api/2.22/quotas/users | Params: file_system_ids(array), file_system_names(array), uids(array), user_names(array) | Body: name(ro string), quota(integer)
PATCH /api/2.22/quotas/users | Params: file_system_ids(array), file_system_names(array), uids(array), user_names(array) | Body: name(ro string), quota(integer)
DELETE /api/2.22/quotas/users | Params: file_system_ids(array), file_system_names(array), uids(array), user_names(array)

RDL

GET /api/2.22/rapid-data-locking
PATCH /api/2.22/rapid-data-locking | Body: enabled(boolean), kmip_server(object)
POST /api/2.22/rapid-data-locking/rotate
GET /api/2.22/rapid-data-locking/test

Realms

GET /api/2.22/realms | Params: destroyed(boolean), total_only(boolean)
POST /api/2.22/realms | Params: without_default_access_list(boolean*)
PATCH /api/2.22/realms | Body: default_inbound_tls_policy(object), destroyed(boolean), id(ro string), name(string)
DELETE /api/2.22/realms
GET /api/2.22/realms/defaults | Params: realm_ids(array), realm_names(array)
PATCH /api/2.22/realms/defaults | Params: realm_ids(array), realm_names(array) | Body: context(ro object), object_store(array), realm(ro object)
GET /api/2.22/realms/space | Params: end_time(integer), resolution(integer), start_time(integer), total_only(boolean), type(string)
GET /api/2.22/realms/space/storage-classes | Params: end_time(integer), resolution(integer), start_time(integer), storage_class_names(array), total_only(boolean)

Remote Arrays

GET /api/2.22/remote-arrays | Params: current_fleet_only(boolean), total_only(boolean)

Resource Accesses

GET /api/2.22/resource-accesses
DELETE /api/2.22/resource-accesses
POST /api/2.22/resource-accesses/batch

Roles

GET /api/2.22/roles

SAML2 SSO

GET /api/2.22/sso/saml2/idps
POST /api/2.22/sso/saml2/idps | Body: array_url(string), binding(string), enabled(boolean), idp(object), prn(ro string), services(array), sp(object)
PATCH /api/2.22/sso/saml2/idps | Body: array_url(string), binding(string), enabled(boolean), id(ro string), idp(object), name(string), prn(ro string), services(array), sp(object)
DELETE /api/2.22/sso/saml2/idps
GET /api/2.22/sso/saml2/idps/test
PATCH /api/2.22/sso/saml2/idps/test | Body: array_url(string), binding(string), enabled(boolean), id(ro string), idp(object), name(string), prn(ro string), services(array), sp(object)

SMTP

GET /api/2.22/smtp-servers
PATCH /api/2.22/smtp-servers | Body: encryption_mode(string), id(ro string), name(ro string), relay_host(string), sender_domain(string)

SNMP Agents

GET /api/2.22/snmp-agents
PATCH /api/2.22/snmp-agents | Body: engine_id(ro string), id(ro string), name(ro string), v2c(object), v3(object), version(string)
GET /api/2.22/snmp-agents/mib

SNMP Managers

GET /api/2.22/snmp-managers
POST /api/2.22/snmp-managers | Body: host(string), notification(string), v2c(object), v3(object), version(string)
PATCH /api/2.22/snmp-managers | Body: host(string), id(ro string), name(string), notification(string), v2c(object), v3(object), version(string)
DELETE /api/2.22/snmp-managers
GET /api/2.22/snmp-managers/test

Servers

GET /api/2.22/servers
POST /api/2.22/servers | Params: create_ds(string*) | Body: dns(array)
PATCH /api/2.22/servers | Body: dns(array)
DELETE /api/2.22/servers | Params: cascade_delete(array*)

Sessions

GET /api/2.22/sessions

Software

GET /api/2.22/software-check | Params: software_names(array), software_versions(array), total_item_count(boolean)
POST /api/2.22/software-check | Params: software_names(array), software_versions(array)

Subnets

GET /api/2.22/subnets
POST /api/2.22/subnets | Body: enabled(ro boolean), gateway(string), id(ro string), interfaces(ro array), link_aggregation_group(object), mtu(integer), name(ro string), prefix(string), services(ro array), vlan(integer)
PATCH /api/2.22/subnets | Body: enabled(ro boolean), gateway(string), id(ro string), interfaces(ro array), link_aggregation_group(object), mtu(integer), name(ro string), prefix(string), services(ro array), vlan(integer)
DELETE /api/2.22/subnets

Support

GET /api/2.22/support
PATCH /api/2.22/support | Body: edge_agent_update_enabled(boolean), edge_management_enabled(boolean), id(ro string), name(ro string), phonehome_enabled(boolean), proxy(string), remote_assist_active(boolean), remote_assist_duration(integer), remote_assist_expires(ro string), remote_assist_opened(ro string), remote_assist_paths(ro array), remote_assist_status(ro string)
GET /api/2.22/support/test | Params: test_type(string)

Support Diagnostics

GET /api/2.22/support-diagnostics
POST /api/2.22/support-diagnostics | Params: analysis_period_end_time(integer), analysis_period_start_time(integer)
GET /api/2.22/support-diagnostics/details

Syslog

GET /api/2.22/syslog-servers
POST /api/2.22/syslog-servers | Body: services(array), sources(array), uri(string)
PATCH /api/2.22/syslog-servers | Body: services(array), sources(array), uri(string)
DELETE /api/2.22/syslog-servers
GET /api/2.22/syslog-servers/settings
PATCH /api/2.22/syslog-servers/settings | Body: ca_certificate(object), ca_certificate_group(object), id(ro string), name(ro string)
GET /api/2.22/syslog-servers/test

Targets

GET /api/2.22/targets
POST /api/2.22/targets | Body: address(string)
PATCH /api/2.22/targets | Body: address(string), ca_certificate_group(object), id(ro string), name(string), status(ro string), status_details(ro string)
DELETE /api/2.22/targets
GET /api/2.22/targets/performance/replication | Params: end_time(integer), resolution(integer), start_time(integer), total_only(boolean)

Usage

GET /api/2.22/usage/groups | Params: file_system_ids(array), file_system_names(array), gids(array), group_names(array)
GET /api/2.22/usage/users | Params: file_system_ids(array), file_system_names(array), uids(array), user_names(array)

Verification Keys

GET /api/2.22/support/verification-keys
PATCH /api/2.22/support/verification-keys | Body: signed_verification_key(string)

Data Models (Key Resources)

ActiveDirectory: computer_name(string): The common name of the computer account to be crea | directory_servers(array): A list of directory servers that will be used for | domain(string): The Active Directory domain to join. | encryption_types(array): The encryption types that are supported for use by | global_catalog_servers(array): A list of global catalog servers that will be used | id(ro string): A non-modifiable, globally unique ID chosen by the | join_ou(string): The relative distinguished name of the organizatio | kerberos_servers(array): A list of key distribution servers to use for Kerb | name(ro string): Name of the object (e.g., a file system or snapsho | realms(ro array): The realms containing this active directory accoun | server(object): The server containing this active directory accoun | service_principal_names(array): A list of service principal names registered for t

ActiveDirectoryPatch: directory_servers(array): A list of directory servers that will be used for | encryption_types(array): The encryption types that will be supported for us | fqdns(array): A list of fully qualified domain names to use to r | global_catalog_servers(array): A list of global catalog servers that will be used | join_ou(string): The relative distinguished name of the organizatio | kerberos_servers(array): A list of key distribution servers to use for Kerb | service_principal_names(array): A list of service principal names to register for

ActiveDirectoryPost: computer_name(string): The common name of the computer account to be crea | directory_servers(array): A list of directory servers that will be used for | domain(string): The Active Directory domain to join. | encryption_types(array): The encryption types that will be supported for us | fqdns(array): A list of fully qualified domain names to use to r | global_catalog_servers(array): A list of global catalog servers that will be used | join_ou(string): The relative distinguished name of the organizatio | kerberos_servers(array): A list of key distribution servers to use for Kerb | password(string): The login password of the user with privileges to | service_principal_names(array): A list of service principal names to register for | user(string): The login name of the user with privileges to crea

Admin: api_token(object): API token | context(ro object): The context in which the operation was performed. | id(ro string): A non-modifiable, globally unique ID chosen by the | is_local(ro boolean): Returns a value of true if the user is local to | locked(boolean): Returns a value of true if the user is currently | lockout_remaining(ro integer): The remaining lockout period, in milliseconds, if | management_access_policies(ro array): List of management access policies associated with | name(ro string): Name of the object (e.g., a file system or snapsho | public_key(string): Public key for SSH access. Supported key types are | role(object): Deprecated. role is deprecated in favor of `mana

AdminCache: id(ro string): A non-modifiable, globally unique ID chosen by the | management_access_policies(ro array): List of management access policies associated with | name(ro string): Name of the object (e.g., a file system or snapsho | role(object): Deprecated. role is deprecated in favor of mana | time`(ro integer): Time the role was cached in milliseconds since UNI

AdminPatch: locked(boolean): If set to false, the specified user is unlocked. | old_password(string): Old user password. | password(string): New user password. | public_key(string): Public key for SSH access. Supported key types are | role(object): Deprecated. role is deprecated in favor of `mana

AdminPost: management_access_policies(array): List of management access policies associated with | password(string): New user password. | public_key(string): Public key for SSH access. Supported key types inc | role(object): Deprecated. role is deprecated in favor of `mana

AdminSetting: lockout_duration(integer): The lockout duration, in milliseconds, if a user h | max_login_attempts(integer): The maximum number of failed login attempts allowe | min_password_length(integer): The minimum password length. If not specified, def

Alert: action(ro string): The action of the alert. | code(ro integer): Alert code. | component_name(ro string): The component name of the alert. | component_type(ro string): The component type of the alert. | created(ro integer): The creation timestamp of the alert. | description(ro string): The description of the alert. | duration(ro integer): The duration of the alert. | flagged(boolean): Flagged state of the alert. | id(ro string): A non-modifiable, globally unique ID chosen by the | index(ro integer): The unique index of the alert. | knowledge_base_url(ro string): URL of the relevant Knowledge Base page. | name(ro string): Name of the object (e.g., a file system or snapsho | notified(ro integer): The last notification timestamp of the alert. | severity(ro string): Severity of the alert. Valid values are info, w | state(ro string): The current state of the alert. Valid values are | summary(ro string): The summary of the alert. | updated(ro integer): The last updated timestamp of the alert. | variables(ro object): Key-value pairs of additional information of the a

AlertWatcher: enabled(boolean): Is email notification enabled? If not specified, d | id(ro string): A non-modifiable, globally unique ID chosen by the | minimum_notification_severity(string): The minimum severity that an alert must have in or | name(ro string): Name of the object (e.g., a file system or snapsho

ApiClient: access_policies(ro array): The access policies allowed for ID Tokens issued b | access_token_ttl_in_ms(ro integer): The TTL (Time To Live) duration for which the exch | enabled(boolean): If true, the API client is permitted to exchange | id(ro string): A non-modifiable, globally unique ID chosen by the | issuer(ro string): The name of the identity provider that will be iss | key_id(ro string): The unique identifier for the associated public ke | max_role(object): Deprecated. The maximum Admin Access Policy (previ | name(ro string): Name of the object (e.g., a file system or snapsho | public_key(ro string): The API client's PEM formatted (Base64 encoded) RS

ApiClientsPost: access_policies(array): The access policies allowed for ID Tokens issued b | access_token_ttl_in_ms(integer): The TTL (Time To Live) duration for which the exch | issuer(string): The name of the identity provider that will be iss | max_role(object): Deprecated. The maximum Admin Access Policy (previ | public_key(string): The API client's PEM formatted (Base64 encoded) RS

Array: _as_of(ro integer): Array time in milliseconds since UNIX epoch. | banner(string): A string to be shown when logging in to the array. | context(ro object): The context in which the operation was performed. | default_inbound_tls_policy(object): The default TLS policy governing inbound traffic f | encryption(ro object): | eradication_config(object): | id(ro string): A globally unique, system-generated ID. The ID can | idle_timeout(integer): Idle timeout in milliseconds. Valid values are in | name(string): A user-specified name. The name must be locally un | network_access_policy(object): The network access policy governing which clients | ntp_servers(array): | os(ro string): Valid values are Purity//FA and Purity//FB. | product_type(ro string): For FlashBlade//S arrays, the value is determine | revision(ro string): | security_update(ro string): The name of the installed security update that cur | smb_mode(ro string): The current SMB mode of the array. This controls t | time_zone(string): The time zone to use for the array. In particular | version(ro string):

ArrayConnection: ca_certificate_group(object): The group of CA certificates that can be used, in | context(ro object): The context in which the operation was performed. | encrypted(boolean): If this is set to true, then all customer data r | id(ro string): A non-modifiable, globally unique ID chosen by the | management_address(string): Management address of the target array. Settable o | os(ro string): The operating system of the connected array. | remote(object): The remote array. | replication_addresses(array): IP addresses and/or FQDNs of the target arrays. Se | status(ro string): Status of the connection. Valid values include co | throttle(object): The bandwidth throttling for an array connection o | type(ro string): The type of connection. Valid values include asyn | version(ro string): The version of the target array.

ArrayConnectionKey: connection_key(ro string): Connection-key, used on another array to connect t | created(ro integer): Creation time in milliseconds since UNIX epoch. | expires(ro integer): Expiration time in milliseconds since UNIX epoch.

ArrayConnectionPath: context(ro object): The context in which the operation was performed. | destination(ro string): IP address with the port of the target array. | id(ro string): A non-modifiable, globally unique ID chosen by the | remote(object): The remote array. | source(ro string): IP address of the source array. | status(ro string): Status of the connection. Valid values are connec | status_details(ro string): Additional information describing any issues encou | type(string): The type of path. Valid values include async-repl

ArrayConnectionPost: ca_certificate_group(object): The group of CA certificates that can be used, in | connection_key(string): The connection key of the target array. Settable o | context(ro object): The context in which the operation was performed. | encrypted(boolean): If this is set to true, then all customer data r | id(ro string): A non-modifiable, globally unique ID chosen by the | management_address(string): Management address of the target array. Settable o | os(ro string): The operating system of the connected array. | remote(object): The remote array. | replication_addresses(array): IP addresses and/or FQDNs of the target arrays. Se | status(ro string): Status of the connection. Valid values include co | throttle(object): The bandwidth throttling for an array connection o | type(ro string): The type of connection. Valid values include asyn | version(ro string): The version of the target array.

ArrayErasure: details(string): The detailed reason of the status. | name(string): A name chosen by the user. Can be changed. Must be | sanitization_certificate(string): The sanitization certificate of the factory reset, | status(string): The status of the factory reset process. A status

ArrayHttpSpecificPerformance: context(ro object): The context in which the operation was performed. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(number): Other operations processed per second. | read_dirs_per_sec(number): Read directory requests processed per second. | read_files_per_sec(number): Read file requests processed per second. | time(integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(number): Average time, measured in microseconds, it takes t | usec_per_read_dir_op(number): Average time, measured in microseconds, it takes t | usec_per_read_file_op(number): Average time, measured in microseconds, it takes t | usec_per_write_dir_op(number): Average time, measured in microseconds, it takes t | usec_per_write_file_op(number): Average time, measured in microseconds, it takes t | write_dirs_per_sec(number): Write directory requests processed per second. | write_files_per_sec(number): Write file requests processed per second.

ArrayHttpSpecificPerformanceGet: continuation_token(string): Continuation token that can be provided in the co | errors(ro array): The list of errors encountered when attempting to | items(array): A list of http specific array performance metrics | total_item_count(integer): Total number of items after applying filter` para

ArrayNfsSpecificPerformance: accesses_per_sec(number): ACCESS requests processed per second. | aggregate_file_metadata_creates_per_sec(number): Sum of file-level or directory-level create-like m | aggregate_file_metadata_modifies_per_sec(number): Sum of file-level or directory-level modify-like a | aggregate_file_metadata_reads_per_sec(number): Sum of file-level or directory-level read-like met | aggregate_other_per_sec(number): Sum of all other requests processed per second. Th | aggregate_share_metadata_reads_per_sec(number): Sum of share-level read-like metadata requests per | aggregate_usec_per_file_metadata_create_op(number): Average time, measured in microseconds, it takes t | aggregate_usec_per_file_metadata_modify_op(number): Average time, measured in microseconds, it takes t | aggregate_usec_per_file_metadata_read_op(number): Average time, measured in microseconds, it takes t | aggregate_usec_per_other_op(number): Average time, measured in microseconds, it takes t | aggregate_usec_per_share_metadata_read_op(number): Average time, measured in microseconds, it takes t | context(ro object): The context in which the operation was performed. | creates_per_sec(number): CREATE requests processed per second. | fsinfos_per_sec(number): FSINFO requests processed per second. | fsstats_per_sec(number): FSSTAT requests processed per second. | getattrs_per_sec(number): GETATTR requests processed per second. | id(ro string): A non-modifiable, globally unique ID chosen by the | links_per_sec(number): LINK requests processed per second. | lookups_per_sec(number): LOOKUP requests processed per second. | mkdirs_per_sec(number): MKDIR requests processed per second. | name(ro string): Name of the object (e.g., a file system or snapsho | pathconfs_per_sec(number): PATHCONF requests processed per second. | readdirpluses_per_sec(number): READDIRPLUS requests processed per second. | readdirs_per_sec(number): READDIR requests processed per second. | readlinks_per_sec(number): READLINK requests processed per second. | reads_per_sec(number): READ requests processed per second. | removes_per_sec(number): REMOVE requests processed per second. | renames_per_sec(number): RENAME requests processed per second. | rmdirs_per_sec(number): RMDIR requests processed per second. | setattrs_per_sec(number): SETATTR requests processed per second. | symlinks_per_sec(number): SYMLINK requests processed per second. | time(integer): Sample time in milliseconds since UNIX epoch. | usec_per_access_op(number): Average time, measured in microseconds, it takes t | usec_per_create_op(number): Average time, measured in microseconds, it takes t | usec_per_fsinfo_op(number): Average time, measured in microseconds, it takes t | usec_per_fsstat_op(number): Average time, measured in microseconds, it takes t | usec_per_getattr_op(number): Average time, measured in microseconds, it takes t | usec_per_link_op(number): Average time, measured in microseconds, it takes t | usec_per_lookup_op(number): Average time, measured in microseconds, it takes t | usec_per_mkdir_op(number): Average time, measured in microseconds, it takes t | usec_per_pathconf_op(number): Average time, measured in microseconds, it takes t | usec_per_read_op(number): Average time, measured in microseconds, it takes t | usec_per_readdir_op(number): Average time, measured in microseconds, it takes t | usec_per_readdirplus_op(number): Average time, measured in microseconds, it takes t | usec_per_readlink_op(number): Average time, measured in microseconds, it takes t | usec_per_remove_op(number): Average time, measured in microseconds, it takes t | usec_per_rename_op(number): Average time, measured in microseconds, it takes t | usec_per_rmdir_op(number): Average time, measured in microseconds, it takes t | usec_per_setattr_op(number): Average time, measured in microseconds, it takes t | usec_per_symlink_op(number): Average time, measured in microseconds, it takes t | usec_per_write_op(number): Average time, measured in microseconds, it takes t | writes_per_sec(number): WRITE requests processed per second.

ArrayNfsSpecificPerformanceGet: continuation_token(string): Continuation token that can be provided in the co | errors(ro array): The list of errors encountered when attempting to | items(array): A list of NFS specific array performance metrics o | total_item_count(integer): Total number of items after applying filter` para

ArrayPerformance: bytes_per_op(ro number): Average operation size (read bytes+write bytes/rea | bytes_per_read(ro number): Average read size in bytes per read operation. | bytes_per_write(ro number): Average write size in bytes per write operation. | context(ro object): The context in which the operation was performed. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(ro number): Other operations processed per second. | read_bytes_per_sec(ro number): Bytes read per second. | reads_per_sec(ro number): Read requests processed per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(ro number): Average time, measured in microseconds, it takes t | usec_per_read_op(ro number): Average time, measured in microseconds, it takes t | usec_per_write_op(ro number): Average time, measured in microseconds, it takes t | write_bytes_per_sec(ro number): Bytes written per second. | writes_per_sec(ro number): Write requests processed per second.

ArrayPerformanceReplicationGetResp: continuation_token(string): Continuation token that can be provided in the co | errors(ro array): The list of errors encountered when attempting to | items(array): | total_item_count(integer): Total number of items after applying filter` para

ArrayS3SpecificPerformance: context(ro object): The context in which the operation was performed. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(number): Other operations processed per second. | read_buckets_per_sec(number): Read buckets requests processed per second. | read_objects_per_sec(number): Read object requests processed per second. | time(integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(number): Average time, measured in microseconds, it takes t | usec_per_read_bucket_op(number): Average time, measured in microseconds, it takes t | usec_per_read_object_op(number): Average time, measured in microseconds, it takes t | usec_per_write_bucket_op(number): Average time, measured in microseconds, it takes t | usec_per_write_object_op(number): Average time, measured in microseconds, it takes t | write_buckets_per_sec(number): Write buckets requests processed per second. | write_objects_per_sec(number): Write object requests processed per second.

ArrayS3SpecificPerformanceGetResp: continuation_token(string): Continuation token that can be provided in the co | errors(ro array): The list of errors encountered when attempting to | items(array): A list of S3 specific array performance metrics ob | total_item_count(integer): Total number of items after applying filter` para

ArraySpace: capacity(integer): Usable capacity in bytes. | context(ro object): The context in which the operation was performed. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | parity(number): A representation of data redundancy on the array. | space(object): | time(integer): Sample time in milliseconds since UNIX epoch.

AuditFileSystemsPoliciesPatch: add_log_targets(array): The log targets which will be added to the existin | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | remove_log_targets(array): The log targets which will be removed from the exi | rules(array): All of the rules that are part of this policy.

AuditFileSystemsPoliciesPost: control_type(string): Specifies the evaluation mode for auditing in this | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy.

AuditFileSystemsPolicy: context(ro object): The context in which the operation was performed. | control_type(string): Specifies the evaluation mode for auditing in this | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy.

AuditFileSystemsPolicyNoContext: control_type(string): Specifies the evaluation mode for auditing in this | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy.

AuditFileSystemsPolicyPatchBase: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy.

AuditFileSystemsPolicyRuleBase: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | op_status(string): Status of the operation to be audited by this rule | operations(array): The list of operations to be audited by this rule.

AuditFileSystemsPolicyRuleInPolicy: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | op_status(string): Status of the operation to be audited by this rule | operations(array): The list of operations to be audited by this rule.

AuditObjectStorePoliciesPatch: add_log_targets(array): The log targets which will be added to the existin | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | remove_log_targets(array): The log targets which will be removed from the exi

AuditObjectStorePoliciesPost: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

AuditObjectStorePolicy: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

AuditObjectStorePolicyWithContext: context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

AuditObjectStorePolicyWithWritableReference: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | log_targets(array): List of targets which will be utilized for audit l | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

Blade: details(ro string): | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | progress(ro number): | raw_capacity(ro integer): | status(ro string): Valid values are critical, evacuated, evacuat | target`(ro string):

Bucket: account(object): | bucket_type(ro string): The bucket type for the bucket. | context(ro object): The context in which the operation was performed. | created(ro integer): Creation timestamp of the object. | destroyed(boolean): Is the bucket destroyed? | eradication_config(object): | hard_limit_enabled(boolean): If set to true, the bucket's size, as defined by | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | object_count(ro integer): The count of objects within the bucket. | object_lock_config(object): | public_access_config(object): Configuration settings related to public access. | public_status(ro string): Bucket's public status. Valid values include buck | qos_policy(object): The QoS policy for the bucket defines the performa | quota_limit(integer): The effective quota limit applied against the size | retention_lock(string): If set to ratcheted, then object_lock_config.de | space(object): The space specification of the bucket. | storage_class(object): | time_remaining(ro integer): Time in milliseconds before the bucket is eradicat | time_remaining_status(ro string): Status of the time_remaining field. calculating | versioning`(string): The versioning state for objects within the bucket

BucketAccessPolicy: bucket(object): The bucket to which this policy belongs. | context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array):

BucketAccessPolicyRule: actions(array): The list of actions granted by this rule. Each inc | effect(ro string): Effect of this rule. When allow, the rule allows | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | principals(object): The principals to which this rule applies. Current | resources(array): The list of resources which this rule applies to.

BucketAccessPolicyRuleBulkManage: actions(array): The list of actions granted by this rule. Each inc | effect(ro string): Effect of this rule. When allow, the rule allows | name(string): Name of the object (e.g., a file system or snapsho | principals(object): The principals to which this rule applies. Current | resources(array): The list of resources which this rule applies to.

BucketAccessPolicyRulePost: actions(array): The list of actions granted by this rule. Each inc | effect(ro string): Effect of this rule. When allow, the rule allows | principals(object): The principals to which this rule applies. Current | resources(array): The list of resources which this rule applies to.

BucketAccessPolicyRuleWithContext: actions(array): The list of actions granted by this rule. Each inc | context(ro object): The context in which the operation was performed. | effect(ro string): Effect of this rule. When allow, the rule allows | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | principals(object): The principals to which this rule applies. Current | resources(array): The list of resources which this rule applies to.

BucketAuditFilter: actions(array): The list of ops to be audited by this filter. | bucket(object): Reference to the bucket to which this filter belon | name(ro string): Name of the object (e.g., a file system or snapsho | s3_prefixes(array): The list of object name prefixes. The correspondin

BucketAuditFilterActionWithContext: context(ro object): The context in which the operation was performed. | description(ro string): A description of the action. | name(ro string): Name of the object (e.g., a file system or snapsho

BucketAuditFilterWithContext: actions(array): The list of ops to be audited by this filter. | bucket(object): Reference to the bucket to which this filter belon | context(ro object): The context in which the operation was performed. | name(ro string): Name of the object (e.g., a file system or snapsho | s3_prefixes(array): The list of object name prefixes. The correspondin

BucketPatch: destroyed(boolean): Is the bucket destroyed? | eradication_config(object): Configuration settings related to bucket eradicati | hard_limit_enabled(boolean): If set to true, the bucket's size, as defined by | object_lock_config(object): | public_access_config(object): Configuration settings related to public access. | qos_policy(object): The QoS policy for the bucket defines the performa | quota_limit(string): The effective quota limit applied against the size | retention_lock(string): If set to ratcheted, then object_lock_config.de | storage_class(object): | versioning`(string): The versioning state for objects within the bucket

BucketPerformance: bytes_per_op(ro number): Average operation size (read bytes+write bytes/rea | bytes_per_read(ro number): Average read size in bytes per read operation. | bytes_per_write(ro number): Average write size in bytes per write operation. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(ro number): Other operations processed per second. | read_bytes_per_sec(ro number): Bytes read per second. | reads_per_sec(ro number): Read requests processed per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(ro number): Average time, measured in microseconds, it takes t | usec_per_read_op(ro number): Average time, measured in microseconds, it takes t | usec_per_write_op(ro number): Average time, measured in microseconds, it takes t | write_bytes_per_sec(ro number): Bytes written per second. | writes_per_sec(ro number): Write requests processed per second.

BucketPerformanceItems: bytes_per_op(ro number): Average operation size (read bytes+write bytes/rea | bytes_per_read(ro number): Average read size in bytes per read operation. | bytes_per_write(ro number): Average write size in bytes per write operation. | id(ro string): A non-modifiable, globally unique ID chosen by the | max_total_bytes_per_sec(ro number): Limit on throughput in bytes per bucket. | max_total_ops_per_sec(ro number): Limit on operation count per bucket. | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(ro number): Other operations processed per second. | read_bytes_per_sec(ro number): Bytes read per second. | reads_per_sec(ro number): Read requests processed per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(ro number): Average time, measured in microseconds, it takes t | usec_per_read_op(ro number): Average time, measured in microseconds, it takes t | usec_per_write_op(ro number): Average time, measured in microseconds, it takes t | write_bytes_per_sec(ro number): Bytes written per second. | writes_per_sec(ro number): Write requests processed per second.

BucketPost: account(object): The account name for bucket creation. | bucket_type(string): The bucket type for the bucket. Valid values are |eradication_config(object): Configuration settings related to bucket eradicati | hard_limit_enabled(boolean): If set to true, the bucket's size, as defined by | object_lock_config(object): | quota_limit(string): The effective quota limit applied against the size | retention_lock(string): If set to ratcheted, then object_lock_config.de

BucketReplicaLink: cascading_enabled(ro boolean): If set to true, objects replicated to this bucke | context(ro object): The context in which the operation was performed. | direction(ro string): The direction of replication. Valid values are in | id(ro string): A non-modifiable, globally unique ID chosen by the | lag(ro integer): Duration in milliseconds that represents how far b | local_bucket(object): Reference to a local bucket. | object_backlog(object): The number of pending operations and their size th | paused(boolean): Is the replica link paused? | recovery_point(ro integer): Time, in milliseconds since UNIX epoch, where all | remote(object): Reference to the associated remote, which can eith | remote_bucket(object): Reference to a remote bucket. | remote_credentials(object): Reference to a remote-credentials object to access | status(ro string): Status of the replica link. Values include replic | status_details(ro string): Detailed information about the status of the repli

BucketS3SpecificPerformance: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(ro number): Other operations processed per second. | read_buckets_per_sec(ro number): Read buckets requests processed per second. | read_objects_per_sec(ro number): Read object requests processed per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(ro number): Average time, measured in microseconds, it takes t | usec_per_read_bucket_op(ro number): Average time, measured in microseconds, it takes t | usec_per_read_object_op(ro number): Average time, measured in microseconds, it takes t | usec_per_write_bucket_op(ro number): Average time, measured in microseconds, it takes t | usec_per_write_object_op(ro number): Average time, measured in microseconds, it takes t | write_buckets_per_sec(ro number): Write buckets requests processed per second. | write_objects_per_sec(ro number): Write object requests processed per second.

BucketS3SpecificPerformanceGetResp: continuation_token(string): Continuation token that can be provided in the co | items(array): A list of S3 specific bucket performance metrics o | total(array): Total of all records after filtering. If total_on | total_item_count(integer): Total number of items after applying filter para

Certificate: certificate(string): The text of the certificate. | certificate_type(string): The type of certificate. Possible values are appl | common_name(string): The common name field listed in the certificate. | country(string): The country field listed in the certificate. | email(string): The email field listed in the certificate. | id(ro string): A non-modifiable, globally unique ID chosen by the | intermediate_certificate(string): Intermediate certificate chains. | issued_by(ro string): Who issued this certificate. | issued_to(ro string): Who this certificate was issued to. | key_algorithm(string): The key algorithm used to generate the certificate | key_size(integer): The size (in bits) of the private key for the cert | locality(string): The locality field listed in the certificate. | name(ro string): Name of the object (e.g., a file system or snapsho | organization(string): The organization field listed in the certificate. | organizational_unit(string): The organizational unit field listed in the certif | realms(ro array): The realms containing this certificate. | state(string): The state/province field listed in the certificate | status(ro string): The type of certificate. Valid values are self-si | subject_alternative_names(array): The alternative names that are secured by this cer | valid_from(ro integer): The date when the certificate starts being valid. | valid_to(ro integer): The date when the certificate stops being valid.

CertificateCertificateGroupGetResp: continuation_token(string): Continuation token that can be provided in the co | items(array): A list of certificate and certificate group relati | total_item_count(integer): Total number of items after applying filter` para

CertificateGroup: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | realms(ro array): The realms containing this certificate group.

CertificateGroupCertificateGetResp: continuation_token(string): Continuation token that can be provided in the co | items(array): A list of certificate and certificate group relati | total_item_count(integer): Total number of items after applying filter` para

CertificateGroupUse: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | use(object): A reference to an object using this certificate gr

CertificatePatch: certificate(string): The text of the certificate. | certificate_type(string): The type of certificate. Possible values are appl | common_name(string): The common name field listed in the certificate. | country(string): The country field listed in the certificate. | days(integer): The number of days that the self-signed certificat | email(string): The email field listed in the certificate. | intermediate_certificate(string): Intermediate certificate chains. | issued_by(ro string): Who issued this certificate. | issued_to(ro string): Who this certificate was issued to. | key_algorithm(string): The key algorithm used to generate the certificate | key_size(integer): The size (in bits) of the private key for the cert | locality(string): The locality field listed in the certificate. | organization(string): The organization field listed in the certificate. | organizational_unit(string): The organizational unit field listed in the certif | passphrase(string): The passphrase used to encrypt private_key. This | private_key(string): The text of the private key. This field can only b | realms(ro array): The realms containing this certificate. | state(string): The state/province field listed in the certificate | status(ro string): The type of certificate. Valid values are self-si | subject_alternative_names(array): The alternative names that are secured by this cer | valid_from(ro integer): The date when the certificate starts being valid. | valid_to(ro integer): The date when the certificate stops being valid.

CertificatePost: certificate(string): The text of the certificate. | certificate_type(string): The type of certificate. Possible values are appl | common_name(string): The common name field listed in the certificate. | country(string): The country field listed in the certificate. | days(integer): The number of days that the self-signed certificat | email(string): The email field listed in the certificate. | intermediate_certificate(string): Intermediate certificate chains. | issued_by(ro string): Who issued this certificate. | issued_to(ro string): Who this certificate was issued to. | key_algorithm(string): The key algorithm used to generate the certificate | key_size(integer): The size (in bits) of the private key for the cert | locality(string): The locality field listed in the certificate. | organization(string): The organization field listed in the certificate. | organizational_unit(string): The organizational unit field listed in the certif | passphrase(string): The passphrase used to encrypt private_key. This | private_key(string): The text of the private key. This field can only b | realms(ro array): The realms containing this certificate. | state(string): The state/province field listed in the certificate | status(ro string): The type of certificate. Valid values are self-si | subject_alternative_names(array): The alternative names that are secured by this cer | valid_from(ro integer): The date when the certificate starts being valid. | valid_to(ro integer): The date when the certificate stops being valid.

CertificateSigningRequestPost: certificate(object): The certificate object whose private key will be u | common_name(string): The common name field to be listed in the certific | country(string): Two-letter country (ISO) code to be listed in the | email(string): The email field to be listed in the certificate. | locality(string): The locality field to be listed in the certificate | organization(string): The organization field to be listed in the certifi | organizational_unit(string): The organizational unit field to be listed in the | state(string): The state/province field to be listed in the certi | subject_alternative_names(array): The alternative names that are secured by this cer

CertificateUse: group(object): A reference to a certificate group that is being u | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | use(object): A reference to an object using this certificate.

ClientsPerformance: bytes_per_op(ro number): Average operation size (read bytes+write bytes/rea | bytes_per_read(ro number): Average read size in bytes per read operation. | bytes_per_write(ro number): Average write size in bytes per write operation. | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(ro number): Other operations processed per second. | read_bytes_per_sec(ro number): Bytes read per second. | reads_per_sec(ro number): Read requests processed per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(ro number): Average time, measured in microseconds, it takes t | usec_per_read_op(ro number): Average time, measured in microseconds, it takes t | usec_per_write_op(ro number): Average time, measured in microseconds, it takes t | write_bytes_per_sec(ro number): Bytes written per second. | writes_per_sec(ro number): Write requests processed per second.

ClientsS3SpecificPerformance: name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(number): Other operations processed per second. | read_buckets_per_sec(number): Read buckets requests processed per second. | read_objects_per_sec(number): Read object requests processed per second. | time(integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(number): Average time, measured in microseconds, it takes t | usec_per_read_bucket_op(number): Average time, measured in microseconds, it takes t | usec_per_read_object_op(number): Average time, measured in microseconds, it takes t | usec_per_write_bucket_op(number): Average time, measured in microseconds, it takes t | usec_per_write_object_op(number): Average time, measured in microseconds, it takes t | write_buckets_per_sec(number): Write buckets requests processed per second. | write_objects_per_sec(number): Write object requests processed per second.

ConnectionRelationshipPerformanceReplication: aggregate(object): Total bytes transmitted or received per second for | continuous(object): Object backlog information and total bytes transmi | id(ro string): A non-modifiable, globally unique ID chosen by the | periodic(object): Total bytes transmitted or received per second for | remote(object): Reference to a remote array. | time(ro integer): Sample time in milliseconds since UNIX epoch.

ConnectionRelationshipPerformanceReplicationGetResp: continuation_token(string): Continuation token that can be provided in the co | items(array): | total(array): Total of all records after filtering. If total_on | total_item_count(integer): Total number of items after applying filter para

CrossOriginResourceSharingPolicy: bucket(object): The bucket to which this policy belongs. | context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array):

CrossOriginResourceSharingPolicyRule: allowed_headers(array): A list of headers that are permitted to be include | allowed_methods(array): A list of HTTP methods that are permitted for cros | allowed_origins(array): A list of origins (domains) that are permitted to | context(ro object): The context in which the operation was performed. | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs.

CrossOriginResourceSharingPolicyRuleBulkManage: allowed_headers(array): A list of headers that are permitted to be include | allowed_methods(array): A list of HTTP methods that are permitted for cros | allowed_origins(array): A list of origins (domains) that are permitted to | name(string): Name of the object (e.g., a file system or snapsho

CrossOriginResourceSharingPolicyRulePost: allowed_headers(array): A list of headers that are permitted to be include | allowed_methods(array): A list of HTTP methods that are permitted for cros | allowed_origins(array): A list of origins (domains) that are permitted to

CrossOriginResourceSharingPolicyRuleWithContext: allowed_headers(array): A list of headers that are permitted to be include | allowed_methods(array): A list of HTTP methods that are permitted for cros | allowed_origins(array): A list of origins (domains) that are permitted to | context(ro object): The context in which the operation was performed. | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs.

DataEvictionPolicy: context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | keep_size(integer): The maximum physical data space(in bytes) of a tar | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

DataEvictionPolicyPost: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | keep_size(integer): The maximum physical data space (in bytes) of a ta | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

DirectoryService: base_dn(string): Base of the Distinguished Name (DN) of the directo | bind_password(string): Obfuscated password used to query the directory. | bind_user(string): Username used to query the directory. | ca_certificate(object): CA certificate used to validate the authenticity o | ca_certificate_group(object): A certificate group containing CA certificates tha | enabled(boolean): Is the directory service enabled or not? | id(ro string): A non-modifiable, globally unique ID chosen by the | management(object): Properties specific to the management service. | name(ro string): Name of the object (e.g., a file system or snapsho | nfs(object): Properties specific to the NFS service. | services(ro array): Services that the directory service configuration | smb(object): DEPRECATED - Properties specific to the SMB servic | uris(array): List of URIs for the configured directory servers.

DirectoryServiceRole: group(string): Common Name (CN) of the directory service group co | group_base(string): Specifies where the configured group is located in | id(ro string): A non-modifiable, globally unique ID chosen by the | management_access_policies(ro array): List of management access policies associated with | name(ro string): Name of the role mapping object. | role(object): Deprecated. role is deprecated in favor of `mana

DirectoryServiceRolePost: group(string): Common Name (CN) of the directory service group co | group_base(string): Specifies where the configured group is located in | management_access_policies(array): List of management access policies associated with | role(object): Deprecated. role is deprecated in favor of `mana

Dns: domain(string): Domain suffix to be appended by the appliance when | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | nameservers(array): List of DNS server IP addresses. | realms(ro array): The realms containing this DNS. | services(array): The list of services utilizing the DNS configurati | sources(array): The network interfaces used for communication with

DnsPost: domain(string): Domain suffix to be appended by the appliance when | nameservers(array): List of DNS server IP addresses. | services(array): The list of services utilizing the DNS configurati | sources(array): The network interfaces used for communication with

Drive: details(ro string): Details about the status of the drive if not healt | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | progress(ro number): Reflects this drive's current progress toward comp | raw_capacity(ro integer): | status(ro string): Current status of the drive. Valid values are eva | type(ro string): The type of the module. Valid values are DFM` and

FileLock: access_type(ro string): Type of access the lock provides. Valid values are | client(object): Reference to the file system client that holds the | context(ro object): The context in which the operation was performed. | created_at(integer): Creation timestamp of the lock. Measured in millis | inode(ro integer): The inode of the file where the lock is found rela | name(ro string): Name of the object (e.g., a file system or snapsho | path(ro string): Path to the file where the lock is found relative | protocol(ro string): The protocol utilized for obtaining and managing t | range(object): The range in bytes (offset, length) the lock c | source(object): Reference to location where the path/inode can be

FileSession: authentication(ro string): Describes how was the user authenticated. Valid va | client(object): Client that holds the session. | connection_time(integer): Connection time in milliseconds since UNIX epoch. | context(ro object): The context in which the operation was performed. | idle_time(integer): Duration in milliseconds that indicates how long t | name(ro string): Name of the object (e.g., a file system or snapsho | opens(integer): Number of opens for the given session. | port(integer): Port number the client is connected from. | protocol(ro string): The protocol utilized for obtaining and managing t | time(integer): Current time in milliseconds since UNIX epoch. | user(object): The user who has created the session.

FileSystem: context(ro object): The context in which the operation was performed. | created(ro integer): Creation timestamp of the file system. | default_group_quota(integer): The default space quota for a group writing to thi | default_user_quota(integer): The default space quota for a user writing to this | destroyed(boolean): Returns a value of true if the file system has b | eradication_config(object): Configuration settings related to file system erad | fast_remove_directory_enabled(boolean): If set to true, the file system, when mounted, w | group_ownership(string): The group ownership for new files and directories | hard_limit_enabled(boolean): If set to true, the file system's size, as defin | http(object): HTTP configuration. | id(ro string): A non-modifiable, globally unique ID chosen by the | multi_protocol(object): Multi-protocol configuration. | name(ro string): Name of the object (e.g., a file system or snapsho | nfs(object): NFS configuration. | node_group(object): The nodes contains the data of the file system. | promotion_status(ro string): Possible values are promoted and demoted. The | provisioned(integer): The provisioned size of the file system, displayed | qos_policy(object): The QoS policy for the File System defines the per | realms(ro array): The realms containing this file system. | requested_promotion_state(string): Possible values are promoted and demoted. The | smb(object): SMB configuration. | snapshot_directory_enabled(boolean): If set to true, a hidden .snapshot directory wil | source(object): A reference to the source file system. | space(object): The space usage of the file system. | storage_class(object): | time_remaining(ro integer): Time in milliseconds before the file system is era | writable(boolean): Whether the file system is writable or not. If `fa

FileSystemExport: context(ro object): The context in which the operation was performed. | enabled(ro boolean): Returns a value of true if and only if the expor | export_name(string): The name of the export used by clients to mount th | id(ro string): A non-modifiable, globally unique ID chosen by the | member(object): Reference to the file system the policy is applied | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): Reference to the NFS export policy or SMB client p | policy_type(ro string): Policy type attached to the export. It is either S | server(object): Reference to the server the export will be visible | share_policy(object): Reference to the SMB share policy (only used for S | status(ro string): Explains why enabled is false. Valid values in

FileSystemExportPost: export_name(string): The name of the export to create. Export names mus | server(object): Reference to the server the export will be visible | share_policy(object): Reference to the SMB share policy (only used for S

FileSystemGroupPerformance: bytes_per_op(ro number): Average operation size (read bytes+write bytes/rea | bytes_per_read(ro number): Average read size in bytes per read operation. | bytes_per_write(ro number): Average write size in bytes per write operation. | file_system(object): The file system on which the performance was measu | group(object): The group whose performance is represented. | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(ro number): Other operations processed per second. | read_bytes_per_sec(ro number): Bytes read per second. | reads_per_sec(ro number): Read requests processed per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(ro number): Average time, measured in microseconds, it takes t | usec_per_read_op(ro number): Average time, measured in microseconds, it takes t | usec_per_write_op(ro number): Average time, measured in microseconds, it takes t | write_bytes_per_sec(ro number): Bytes written per second. | writes_per_sec(ro number): Write requests processed per second.

FileSystemLockNlmReclamation: context(ro object): The context in which the operation was performed. | end(ro integer): End time of the NLM reclamation in milliseconds si | start(integer): Start time of the NLM reclamation in milliseconds

FileSystemOpenFile: client(object): Client that has the file open. | id(string): The unique identifier of the open file. | lock_count(integer): The number of locks on the file. | mode(string): The mode in which the file is open: "ro" for Read- | path(string): The path to the open file. | session(object): The name of the session with the open file. | source(object): Reference to the file system. | user(object): The user who has the file open.

FileSystemPatch: created(ro integer): Creation timestamp of the file system. | default_group_quota(integer): The default space quota for a group writing to thi | default_user_quota(integer): The default space quota for a user writing to this | destroyed(boolean): Returns a value of true if the file system has b | fast_remove_directory_enabled(boolean): If set to true, the file system, when mounted, w | group_ownership(string): The group ownership for new files and directories | hard_limit_enabled(boolean): If set to true, the file system's size, as defin | http(object): HTTP configuration. | id(ro string): A globally unique, system-generated ID. The ID can | multi_protocol(object): Multi-protocol configuration. | name(string): A user-specified name. The name must be locally un | nfs(object): NFS configuration. | promotion_status(ro string): Possible values are promoted and demoted. The | provisioned(integer): The provisioned size of the file system, displayed | qos_policy(object): The QoS policy for the File System defines the per | requested_promotion_state(string): Possible values are promoted and demoted. The | smb(object): SMB configuration. | snapshot_directory_enabled(boolean): If set to true, a hidden .snapshot directory wil | source(object): A reference to the source file system. | storage_class(object): | time_remaining(ro integer): Time in milliseconds before the file system is era | writable(boolean): Whether the file system is writable or not. If `fa

FileSystemPerformance: bytes_per_op(ro number): Average operation size (read bytes+write bytes/rea | bytes_per_read(ro number): Average read size in bytes per read operation. | bytes_per_write(ro number): Average write size in bytes per write operation. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(ro number): Other operations processed per second. | read_bytes_per_sec(ro number): Bytes read per second. | reads_per_sec(ro number): Read requests processed per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(ro number): Average time, measured in microseconds, it takes t | usec_per_read_op(ro number): Average time, measured in microseconds, it takes t | usec_per_write_op(ro number): Average time, measured in microseconds, it takes t | write_bytes_per_sec(ro number): Bytes written per second. | writes_per_sec(ro number): Write requests processed per second.

FileSystemPost: default_group_quota(integer): The default space quota for a group writing to thi | default_user_quota(integer): The default space quota for a user writing to this | eradication_config(object): Configuration settings related to file system erad | fast_remove_directory_enabled(boolean): If set to true, the file system, when mounted, w | group_ownership(string): The group ownership for new files and directories | hard_limit_enabled(boolean): If set to true, the file system's size, as defin | http(object): HTTP configuration. | multi_protocol(object): Multi-protocol configuration. | nfs(object): NFS configuration. | node_group(object): The node group's nodes are where the file system's | provisioned(integer): The provisioned size of the file system, displayed | qos_policy(object): The QoS policy for the File System defines the per | requested_promotion_state(ro string): Possible values are promoted and demoted. The | smb(object): SMB configuration. | snapshot_directory_enabled(boolean): If set to true, a hidden .snapshot directory wil | source(object): The source snapshot whose data is copied to the fi | writable(boolean): Whether the file system is writable or not. If `fa

FileSystemReplicaLink: context(ro object): The context in which the operation was performed. | direction(ro string): The direction of replication. Valid values are in | id(ro string): A non-modifiable, globally unique ID chosen by the | lag(ro integer): Duration in milliseconds that represents how far b | link_type(string): Type of the replica link. Values include full-rep | local_file_system(object): Reference to a local file system. | policies(array): | recovery_point(ro integer): Time when the last replicated snapshot was created | remote(object): Reference to a remote array. | remote_file_system(object): Reference to a remote file system. | status(ro string): Status of the replica link. Values include replic | status_details`(ro string): Detailed information about the status of the repli

FileSystemSnapshot: context(ro object): The context in which the operation was performed. | created(ro integer): Creation timestamp of the object. | destroyed(boolean): Is the file system snapshot destroyed? If not spec | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | owner(object): A reference to the file system that owns this snap | owner_destroyed(ro boolean): Is the owning file system destroyed? | policies(ro array): An array of references to the associated policies. | policy(object): A reference to the associated policy that drives t | source(object): A reference to the file system that was the source | suffix(ro string): The suffix of the snapshot, e.g., snap1. | time_remaining(ro integer): Time in milliseconds before the file system snapsh

FileSystemSnapshotTransfer: completed(ro integer): A timestamp at which the replication of the snapsh | context(ro object): The context in which the operation was performed. | data_transferred(ro integer): The amount of data transferred to the target, in b | direction(ro string): The direction of replication. Valid values are in | id(ro string): A non-modifiable, globally unique ID chosen by the | local_snapshot(object): A reference to the associated local file system sn | name(ro string): Name of the object (e.g., a file system or snapsho | progress(ro number): A percentage that indicates how much progress has | remote(object): The array where the remote file system snapshot is | remote_snapshot(object): A reference to the associated remote file system s | started(ro integer): A timestamp at which the replication of the snapsh | status`(ro string): The status of current replication. Valid values ar

FileSystemStorageClassSpace: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | space(object): | storage_class(string): The storage class type of the space information, e | time(integer): Sample time in milliseconds since UNIX epoch.

FileSystemUserPerformance: bytes_per_op(ro number): Average operation size (read bytes+write bytes/rea | bytes_per_read(ro number): Average read size in bytes per read operation. | bytes_per_write(ro number): Average write size in bytes per write operation. | file_system(object): The file system on which the performance was measu | name(ro string): Name of the object (e.g., a file system or snapsho | others_per_sec(ro number): Other operations processed per second. | read_bytes_per_sec(ro number): Bytes read per second. | reads_per_sec(ro number): Read requests processed per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | usec_per_other_op(ro number): Average time, measured in microseconds, it takes t | usec_per_read_op(ro number): Average time, measured in microseconds, it takes t | usec_per_write_op(ro number): Average time, measured in microseconds, it takes t | user(object): The user whose performance is represented. | write_bytes_per_sec(ro number): Bytes written per second. | writes_per_sec(ro number): Write requests processed per second.

Fleet: id(ro string): A globally unique, system-generated ID. The ID can | is_local(boolean): If set to true, the current array is a member of | name(string): A user-specified name. The name must be locally un

FleetKey: created(ro integer): Creation time in milliseconds since UNIX epoch. | expires(ro integer): Expiration time in milliseconds since UNIX epoch. | fleet_key(ro string): Fleet key, used for fleet connections. After creat

FleetMember: coordinator_of(array): List of array groups that the member is the coordi | fleet(object): | member(object): | status(string): Current fleet membership status Valid values are o | status_details(string): Describes the error, if any.

GroupQuota: context(ro object): The context in which the operation was performed. | file_system(object): | file_system_default_quota(ro integer): File system's default group quota (in bytes). If i | group(object): The group on which this quota is enforced. | name(ro string): Name of the object (e.g., a file system or snapsho | quota(integer): The space limit of the quota (in bytes) for the sp | usage(ro integer): The usage of the file system (in bytes) by the spe

Hardware: data_mac(ro string): Ethernet (data) MAC address | details(ro string): Details about the status of the component if not h | id(ro string): A non-modifiable, globally unique ID chosen by the | identify_enabled(boolean): State of an LED used to visually identify the comp | index(ro integer): Number that identifies the relative position of a | management_mac(ro string): Hardware component (burned-in) MAC address | model(ro string): Model number of the hardware component. | name(ro string): Name of the object (e.g., a file system or snapsho | part_number(ro string): Part number of the hardware component. | sensor_readings(ro array): | serial(ro string): Serial number of the hardware component. | slot(ro integer): Slot number occupied by the PCI Express card that | speed(ro integer): The maximum speed (in b/s) at which the component | status(ro string): Component status. Valid values are critical, he | temperature(ro integer): Temperature (in degrees celsius) reported by the c | type(ro string): Type of hardware component. Valid values are bay`

HardwareConnector: connector_type(ro string): Form-factor of the interface. Valid values include | id(ro string): A non-modifiable, globally unique ID chosen by the | lane_speed(integer): Configured speed of each lane in the connector in | lanes_per_port(integer): Configured number of lanes comprising each port in | name(ro string): Name of the object (e.g., a file system or snapsho | port_count(integer): Configured number of ports in the connector (1/2/4 | port_speed(integer): Configured speed of each port in the connector in | transceiver_type(ro string): Details about the transceiver which is plugged int

HardwareConnectorPerformance: id(ro string): A non-modifiable, globally unique ID chosen by the | link_aggregation_group(object): The link aggregation group which this entity belon | name(ro string): Name of the object (e.g., a file system or snapsho | other_errors_per_sec(ro integer): The sum of unspecified reception and transmission | received_bytes_per_sec(ro integer): Bytes received per second. | received_crc_errors_per_sec(ro integer): Reception CRC errors per second. | received_frame_errors_per_sec(ro integer): Received packet frame errors per second. | received_packets_per_sec(ro integer): Packets received per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | total_errors_per_sec(ro integer): The sum of all reception and transmission errors p | transmitted_bytes_per_sec(ro integer): Bytes transmitted per second. | transmitted_carrier_errors_per_sec(ro integer): Transmission carrier errors per second. | transmitted_dropped_errors_per_sec(ro integer): Transmitted packets dropped per second. | transmitted_packets_per_sec(ro integer): Packets transmitted per second.

HardwareTemperatures: name(ro string): The name of the temperature sensor. | reading(ro number): The latest temperature measurement reported by the | status(ro string): The current operational state of the sensor, indic | thresholds(object): The predefined temperature thresholds for the sens

HardwareTemperaturesThresholds: critical(ro number): The temperature level indicating that the system i | non_critical(ro number): The temperature level at which the system operates | unrecoverable(ro number): The maximum temperature limit beyond which the sys

Keytab: encryption_type(ro string): The encryption type used by the Kerberos key distr | fqdn(ro string): The fully qualified domain name to which the keyta | id(ro string): A non-modifiable, globally unique ID chosen by the | kvno(ro integer): The key version number of the key used to generate | name(ro string): Name of the object (e.g., a file system or snapsho | prefix(ro string): The prefix in the name of the keytab object. This | principal(ro string): The service name for which the keytab was issued. | realm(ro string): The Kerberos realm that issued the keytab. | server(object): The server where the keytab is used. | source(object): A reference to the Active Directory configuration | suffix(ro integer): The suffix in the name of the keytab object, deter

KmipServer: ca_certificate(object): CA certificate used to validate the authenticity o | ca_certificate_group(object): A certificate group containing CA certificates tha | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | uris(array): List of URIs for the configured KMIP servers in th

LegalHold: description(string): The description of the legal hold instance. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | realms(ro array): The realms containing this legal hold.

LegalHoldHeldEntity: file_system(object): Reference to the file system that the legal hold i | legal_hold(object): Reference to the legal hold. | path(string): The path of the file or directory being held. | status(string): The status of the legal hold with respect to the h

LifecycleRule: abort_incomplete_multipart_uploads_after(integer): Duration of time after which incomplete multipart | bucket(object): The bucket which this lifecycle rule is targeting. | cleanup_expired_object_delete_marker(ro boolean): Returns a value of true if the expired object de | context(ro object): The context in which the operation was performed. | enabled(boolean): If set to true, this rule will be enabled. | id(ro string): A non-modifiable, globally unique ID chosen by the | keep_current_version_for(integer): Time after which current versions will be marked e | keep_current_version_until(integer): Time after which current versions will be marked e | keep_previous_version_for(integer): Time after which previous versions will be marked | name(ro string): Name of the object (e.g., a file system or snapsho | prefix(string): Object key prefix identifying one or more objects | rule_id(string): Unique identifier for the rule. Can have a maximum

LifecycleRulePatch: abort_incomplete_multipart_uploads_after(integer): Duration of time after which incomplete multipart | enabled(boolean): If set to true, this rule will be enabled. | keep_current_version_for(integer): Time after which current versions will be marked e | keep_current_version_until(integer): Time after which current versions will be marked e | keep_previous_version_for(integer): Time after which previous versions will be marked | prefix(string): Object key prefix identifying one or more objects

LifecycleRulePost: abort_incomplete_multipart_uploads_after(integer): Duration of time after which incomplete multipart | bucket(object): The bucket name for lifecycle rule creation. | keep_current_version_for(integer): Time after which current versions will be marked e | keep_current_version_until(integer): Time after which current versions will be marked e | keep_previous_version_for(integer): Time after which previous versions will be marked | prefix(string): Object key prefix identifying one or more objects | rule_id(string): Identifier for the rule that is unique to the buck

LinkAggregationGroup: id(ro string): A non-modifiable, globally unique ID chosen by the | lag_speed(ro integer): Combined speed of all ports in the LAG in bits-per | mac_address(ro string): Unique MAC address assigned to the LAG. | name(ro string): Name of the object (e.g., a file system or snapsho | port_speed(ro integer): Configured speed of each port in the LAG in bits-p | ports(array): Ports associated with the LAG. | status(ro string): Health status of the LAG. Valid values are `critic

LinkAggregationGroupPatch: add_ports(array): | ports(array): | remove_ports(array):

LogTargetsFileSystems: file_system(object): The target filesystem where audit logs will be sto | id(ro string): A globally unique, system-generated ID. The ID can | keep_for(integer): Specifies the period that audit logs are retained | keep_size(integer): Specifies the maximum size of audit logs to be ret | name(string): A user-specified name. The name must be locally un

LogTargetsFileSystemsPost: file_system(object): The target filesystem where audit logs will be sto | id(ro string): A globally unique, system-generated ID. The ID can | keep_for(integer): Specifies the period that audit logs are retained | keep_size(integer): Specifies the maximum size of audit logs to be ret | name(string): A user-specified name. The name must be locally un

LogTargetsObjectStore: bucket(object): Reference to the bucket where audit logs will be s | id(ro string): A globally unique, system-generated ID. The ID can | log_name_prefix(object): The prefix of the audit log object. | log_rotate(object): The threshold after which the audit log object wil | name(string): A user-specified name. The name must be locally un

LogTargetsObjectStorePost: bucket(object): Reference to the bucket where audit logs will be s | id(ro string): A globally unique, system-generated ID. The ID can | log_name_prefix(object): The prefix of the audit log object. | log_rotate(object): The threshold after which the audit log object wil | name(string): A user-specified name. The name must be locally un

LogTargetsObjectStoreWithContext: bucket(object): Reference to the bucket where audit logs will be s | context(ro object): The context in which the operation was performed. | id(ro string): A globally unique, system-generated ID. The ID can | log_name_prefix(object): The prefix of the audit log object. | log_rotate(object): The threshold after which the audit log object wil | name(string): A user-specified name. The name must be locally un

LogsAsync: available_files(ro array): All of the available files ready for download. | end_time(integer): When the time window ends (in milliseconds since e | hardware_components(array): All of the hardware components for which logs are | id(ro string): A non-modifiable, globally unique ID chosen by the | last_request_time(ro integer): The last time log preparation was requested (in mi | name(ro string): Name of the object (e.g., a file system or snapsho | processing(ro boolean): Returns a value of true if the logs are being pr | progress(ro number): A representation of log preparation progress. Rang | start_time(integer): When the time window starts (in milliseconds since

MaintenanceWindow: created(ro integer): The maintenance window start time, measured in mil | expires(ro integer): The maintenance window end time, measured in milli | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho

ManagementAccessPolicy: aggregation_strategy(string): When this is set to least-common-permissions, an | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy. The | version(ro string): A hash of the other properties of this resource. T

ManagementAccessPolicyPost: aggregation_strategy(string): When this is set to least-common-permissions, an | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy. The

ManagementAccessPolicyRuleBase: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | role(object): Role defines a set of permissions applicable in a | scope(object): Reference to the resource (e.g. arrays, realms) wh

ManagementAccessPolicyRuleInPolicy: id(ro string): A non-modifiable, globally unique ID chosen by the | index(ro integer): The index within the policy. The index indicates | name(ro string): Name of the object (e.g., a file system or snapsho | role(object): Role defines a set of permissions applicable in a | scope(object): Reference to the resource (e.g. arrays, realms) wh

ManagementAuthenticationPolicy: context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | ssh(object): The management authentication config for SSH login

ManagementAuthenticationPolicyPost: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | ssh(object): The management authentication config for SSH login

NetworkAccessPolicy: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy. The | version(ro string): A hash of the other properties of this resource. T

NetworkAccessPolicyRule: client(string): Specifies the clients that will be permitted or de | effect(string): If set to allow, the specified client will be pe | id(ro string): A non-modifiable, globally unique ID chosen by the | index(integer): The index within the policy. The index indicates | interfaces(array): Specifies which product interfaces this rule appli | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | policy_version(ro string): The policy's version. This can be used when updati

NetworkAccessPolicyRuleBase: client(string): Specifies the clients that will be permitted or de | effect(string): If set to allow, the specified client will be pe | id(ro string): A non-modifiable, globally unique ID chosen by the | interfaces(array): Specifies which product interfaces this rule appli | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | policy_version(ro string): The policy's version. This can be used when updati

NetworkAccessPolicyRuleInPolicy: client(string): Specifies the clients that will be permitted or de | effect(string): If set to allow, the specified client will be pe | id(ro string): A non-modifiable, globally unique ID chosen by the | index(ro integer): The index within the policy. The index indicates | interfaces(array): Specifies which product interfaces this rule appli | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | policy_version(ro string): The policy's version. This can be used when updati

NetworkAccessPolicyRulePost: client(string): Specifies the clients that will be permitted or de | effect(string): If set to allow, the specified client will be pe | id(ro string): A non-modifiable, globally unique ID chosen by the | index(integer): The index within the policy. The index indicates | interfaces(array): Specifies which product interfaces this rule appli | name(ro string): Name of the object (e.g., a file system or snapsho

NetworkAccessPolicyRulePostBase: client(string): Specifies the clients that will be permitted or de | effect(string): If set to allow, the specified client will be pe | id(ro string): A non-modifiable, globally unique ID chosen by the | interfaces(array): Specifies which product interfaces this rule appli | name(ro string): Name of the object (e.g., a file system or snapsho

NetworkConnectionStatistics: current_state(ro string): Valid values include CLOSE_WAIT, CLOSED, ESTA | local(object): The information of the array's network interface t | remote(object): Network information of the remote peer that has co | time`(ro integer): The time the operation was run.

NetworkInterface: address(string): The IPv4 or IPv6 address to be associated with the | attached_servers(array): List of servers that are using this interface for | enabled(ro boolean): Indicates if the specified network interface is en | gateway(ro string): Derived from subnet.gateway. | id(ro string): A non-modifiable, globally unique ID chosen by the | mtu(ro integer): Derived from subnet.mtu. | name(ro string): Name of the object (e.g., a file system or snapsho | netmask(ro string): Derived from subnet.prefix. | realms(ro array): The realms containing this network interface. | services(array): Services and protocols that are enabled on the int | subnet(object): | type(string): The only valid value is vip. | vlan(ro integer): Derived from subnet.vlan.

NetworkInterfaceNeighbor: initial_ttl_in_sec(ro integer): The initial time to live in seconds from when the | local_port(object): A reference to the local network interface the nei | neighbor_chassis(object): | neighbor_port(object):

NetworkInterfacePatch: address(string): The IPv4 or IPv6 address to be associated with the | attached_servers(array): List of servers to be associated with the specifie | services(array): Services and protocols that are enabled on the int

NetworkInterfacePing: component_name(ro string): Name of the component running the check. | destination(ro string): The destination address or hostname provided in th | details(ro string): Giant text block that contains raw output of the o | source(ro string): The address where the check starts. Can be a subne

NetworkInterfaceTrace: component_name(ro string): Name of the component running the check. | destination(ro string): The destination address or hostname provided in th | details(ro string): Giant text block that contains raw output of the o | source(ro string): The address where the check starts. Can be a subne

NetworkInterfacesConnectorsPerformance: flow_control_received_congestion_packets_per_sec(ro integer): Number of congestion control packets received per | flow_control_received_discarded_packets_per_sec(ro integer): Number of received packets that were physically di | flow_control_received_lossless_bytes_per_sec(ro integer): Bytes received per second with lossless flow contr | flow_control_received_pause_frames_per_sec(ro integer): Received pause frames per second. | flow_control_transmitted_congestion_packets_per_sec(ro integer): Number of congestion control packets transmitted p | flow_control_transmitted_discarded_packets_per_sec(ro integer): Number of transmitted packets that were physically | flow_control_transmitted_lossless_bytes_per_sec(ro integer): Bytes transmitted per second with lossless flow co | flow_control_transmitted_pause_frames_per_sec(ro integer): Transmitted pause frames per second. | id(ro string): A non-modifiable, globally unique ID chosen by the | link_aggregation_group(object): The link aggregation group which this entity belon | name(ro string): Name of the object (e.g., a file system or snapsho | other_errors_per_sec(ro integer): The sum of unspecified reception and transmission | rdma_received_req_cqe_errors_per_sec(ro integer): The number of times port detected RDMA CQEs with e | rdma_received_sequence_errors_per_sec(ro integer): The number of received RDMA packet sequence errors | rdma_transmitted_local_ack_timeout_errors_per_sec(ro integer): The number of times RDMA ack timer expired for QPs | received_bytes_per_sec(ro integer): Bytes received per second. | received_crc_errors_per_sec(ro integer): Reception CRC errors per second. | received_frame_errors_per_sec(ro integer): Received packet frame errors per second. | received_packets_per_sec(ro integer): Packets received per second. | time(ro integer): Sample time in milliseconds since UNIX epoch. | total_errors_per_sec(ro integer): The sum of all reception and transmission errors p | transmitted_bytes_per_sec(ro integer): Bytes transmitted per second. | transmitted_carrier_errors_per_sec(ro integer): Transmission carrier errors per second. | transmitted_dropped_errors_per_sec(ro integer): Transmitted packets dropped per second. | transmitted_packets_per_sec(ro integer): Packets transmitted per second.

NetworkInterfacesConnectorsSetting: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | roce(object): RoCE(RDMA over Converged Ethernet) configuration f

NetworkInterfacesConnectorsSettingRoce: default_ecn(object): The default ECN(Explicit Congestion Notification) | default_pfc(object): The default PFC(Priority Flow Control) setting for | enabled(boolean): If true, then RoCE networking is enabled. Otherw | network_congestion_mode(string): The RoCE network mode to be used. Valid values inc | trust_mode(string): The trust mode of the RoCE network. Valid values i

NetworkInterfacesConnectorsSettingRoceEcn: marking_probability(ro number): The ECN marking probability when min ECN marked th | max_ecn_marked_threshold(ro integer): The maximum threshold value in bytes at which the | min_ecn_marked_threshold(ro integer): The minimum threshold value in bytes at which the

NetworkInterfacesConnectorsSettingRocePfc: port_buffer(ro integer): The buffer size in bytes reserved to absorb in-fli | xoff_threshold(ro integer): The PFC XOFF threshold value in bytes. When the bu | xon_threshold(ro integer): The PFC XON threshold value in bytes. When the buf

NfsExportPolicy: context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy. The | version(ro string): A hash of the other properties of this resource. T

NfsExportPolicyPatch: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy. The | version(ro string): A hash of the other properties of this resource. T

NfsExportPolicyPatchRuleInPolicy: access(string): Specifies access control for the export. Valid val | anongid(string): Any user whose GID is affected by an access of |anonuid(string): Any user whose UID is affected by an accessof | atime(boolean): If true, after a read operation has occurred, th | client(string): Specifies the clients that will be permitted to ac | fileid_32bit(boolean): Whether the file id is 32 bits or not. Defaults to | id(ro string): A non-modifiable, globally unique ID chosen by the | index(ro integer): The index within the policy. The index indicates | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio | required_transport_security(string): Specifies the minimum transport security required | secure(boolean): If true, prevents NFS access to client connectio | security(array): The security flavors to use for accessing files on

NfsExportPolicyPost: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy. The

NfsExportPolicyRule: access(string): Specifies access control for the export. Valid val | anongid(integer): Any user whose GID is affected by an access of |anonuid(integer): Any user whose UID is affected by an accessof | atime(boolean): If true, after a read operation has occurred, th | client(string): Specifies the clients that will be permitted to ac | context(ro object): The context in which the operation was performed. | fileid_32bit(boolean): Whether the file id is 32 bits or not. Defaults to | id(ro string): A non-modifiable, globally unique ID chosen by the | index(integer): The index within the policy. The index indicates | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio | policy(object): The policy to which this rule belongs. | policy_version(ro string): The policy's version. This can be used when updati | required_transport_security(string): Specifies the minimum transport security required | secure(boolean): If true, prevents NFS access to client connectio | security(array): The security flavors to use for accessing files on

NfsExportPolicyRuleBase: access(string): Specifies access control for the export. Valid val | anongid(integer): Any user whose GID is affected by an access of |anonuid(integer): Any user whose UID is affected by an accessof | atime(boolean): If true, after a read operation has occurred, th | client(string): Specifies the clients that will be permitted to ac | fileid_32bit(boolean): Whether the file id is 32 bits or not. Defaults to | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio | policy(object): The policy to which this rule belongs. | policy_version(ro string): The policy's version. This can be used when updati | required_transport_security(string): Specifies the minimum transport security required | secure(boolean): If true, prevents NFS access to client connectio | security(array): The security flavors to use for accessing files on

NfsExportPolicyRuleBasePatchRequest: access(string): Specifies access control for the export. Valid val | anongid(string): Any user whose GID is affected by an access of |anonuid(string): Any user whose UID is affected by an accessof | atime(boolean): If true, after a read operation has occurred, th | client(string): Specifies the clients that will be permitted to ac | fileid_32bit(boolean): Whether the file id is 32 bits or not. Defaults to | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio | required_transport_security(string): Specifies the minimum transport security required | secure(boolean): If true, prevents NFS access to client connectio | security(array): The security flavors to use for accessing files on

NfsExportPolicyRuleInPolicy: access(string): Specifies access control for the export. Valid val | anongid(integer): Any user whose GID is affected by an access of |anonuid(integer): Any user whose UID is affected by an accessof | atime(boolean): If true, after a read operation has occurred, th | client(string): Specifies the clients that will be permitted to ac | fileid_32bit(boolean): Whether the file id is 32 bits or not. Defaults to | id(ro string): A non-modifiable, globally unique ID chosen by the | index(ro integer): The index within the policy. The index indicates | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio | policy(object): The policy to which this rule belongs. | policy_version(ro string): The policy's version. This can be used when updati | required_transport_security(string): Specifies the minimum transport security required | secure(boolean): If true, prevents NFS access to client connectio | security(array): The security flavors to use for accessing files on

NfsExportPolicyRulePatch: access(string): Specifies access control for the export. Valid val | anongid(string): Any user whose GID is affected by an access of |anonuid(string): Any user whose UID is affected by an accessof | atime(boolean): If true, after a read operation has occurred, th | client(string): Specifies the clients that will be permitted to ac | fileid_32bit(boolean): Whether the file id is 32 bits or not. Defaults to | id(ro string): A non-modifiable, globally unique ID chosen by the | index(integer): The index within the policy. The index indicates | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio | required_transport_security(string): Specifies the minimum transport security required | secure(boolean): If true, prevents NFS access to client connectio | security(array): The security flavors to use for accessing files on

Node: capacity(ro integer): The available capacity of the node in bytes. | data_addresses(ro array): List of data IP addresses of the node. | details(ro string): The description of the status of the node if not h | id(ro string): A globally unique, system-generated ID. The ID can | management_address(string): The control IP address of the node. A connection w | name(string): A user-specified name. The name must be locally un | raw_capacity(ro integer): The raw capacity of the node in bytes. | serial_number(string): The serial number of the node. If the given serial | status(ro string): The status of the node. Values include critical, | unique(ro integer): The unique physical space occupied by customer dat

NodeGroupUse: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | use(object): A reference to an object using this node group.

ObjectStoreAccessKey: access_key_id(ro string): The access key ID which can be used directly to au | context(ro object): The context in which the operation was performed. | created(ro integer): Creation timestamp of the object. | enabled(boolean): Is the access key enabled? If not specified, defau | name(ro string): Name of the object (e.g., a file system or snapsho | secret_access_key(ro string): The secret access key, only populated on creation | user(ro object): Reference of the associated user.

ObjectStoreAccessPolicy: account(object): Reference of the associated account. If the policy | arn(ro string): Amazon Resource Name of the policy. Used when refe | context(ro object): The context in which the operation was performed. | created(ro integer): Creation timestamp of the object. | description(ro string): A description of the policy, optionally specified | enabled(ro boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): | updated(ro integer): The last updated timestamp of the object.

ObjectStoreAccessPolicyAction: context(ro object): The context in which the operation was performed. | description(ro string): A description of the action. | name(ro string): Name of the object (e.g., a file system or snapsho

ObjectStoreAccount: bucket_defaults(object): Default settings to be applied to newly created bu | context(ro object): The context in which the operation was performed. | created(ro integer): Creation timestamp of the object. | hard_limit_enabled(boolean): If set to true, the account's size, as defined b | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | object_count(ro integer): The count of objects within the account. | public_access_config(object): Configuration settings related to public access. | quota_limit(integer): The effective quota limit applied against the size | realms(ro array): The realms containing this account. | space(object): The space specification of the object store accoun

ObjectStoreAccountExport: context(ro object): The context in which the operation was performed. | enabled(boolean): Returns a value of true if the account export is | id(ro string): A non-modifiable, globally unique ID chosen by the | member(object): References the account which will be exported. | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): References the s3 export policy that is used for t | realms(ro array): A list of realms containing the export. | server(object): The server to which the account will be exported.

ObjectStoreAccountPatch: bucket_defaults(object): Default settings to be applied to newly created bu | hard_limit_enabled(boolean): If set to true, the account's size, as defined b | public_access_config(object): Configuration settings related to public access. | quota_limit(string): The effective quota limit to be applied against th

ObjectStoreAccountPost: account_exports(array): A list of exports to be created for the account. | bucket_defaults(object): Default settings to be applied to newly created bu | hard_limit_enabled(boolean): If set to true, the account's size, as defined b | quota_limit(string): The effective quota limit to be applied against th

ObjectStoreRemoteCredentialGetResp: continuation_token(string): Continuation token that can be provided in the co | errors(ro array): The list of errors encountered when attempting to | items(array): A list of object store remote credentials. | total_item_count(integer): Total number of items after applying filter` para

ObjectStoreRemoteCredentials: access_key_id(string): Access Key ID to be used when connecting to a remo | context(ro object): The context in which the operation was performed. | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | realms(ro array): The realms containing this credentials for remote. | remote(object): Reference to the associated remote, which can eith | secret_access_key(string): Secret Access Key to be used when connecting to a

ObjectStoreRole: account(object): Reference of the associated account. | context(ro object): The context in which the operation was performed. | created(ro integer): Creation timestamp of the object. | id(ro string): A non-modifiable, globally unique ID chosen by the | max_session_duration(integer): The maximum session duration for the role in milli | name(ro string): Name of the object (e.g., a file system or snapsho | prn(ro string): Pure Resource Name of the role | trusted_entities(ro array): List of trusted entities

ObjectStoreTrustPolicy: context(ro object): The context in which the operation was performed. | enabled(ro boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | role(object): Object Store Role to which the Trust Policy applie | rules(array): List of rules establishing the trust policy

ObjectStoreUser: access_keys(ro array): References of the user's access keys. | account(object): Reference of the associated account. | context(ro object): The context in which the operation was performed. | created(ro integer): Creation timestamp of the object. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho

ObjectStoreVirtualHost: attached_servers(array): A list of servers which are allowed to use this vi | context(ro object): The context in which the operation was performed. | hostname(string): A hostname by which the array can be addressed for | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | realms(ro array): A list of realms containing this virtual host.

ObjectStoreVirtualHostPatch: add_attached_servers(array): A list of new servers which are allowed to use thi | attached_servers(array): A list of servers which are allowed to use this vi | hostname(string): A hostname by which the array can be addressed for | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | remove_attached_servers(array): A list of servers which will no longer be allowed

OidcSso: enabled(boolean): If set to true, the OIDC SSO configuration is en | id(ro string): A non-modifiable, globally unique ID chosen by the | idp(object): Identity Provider | name(ro string): Name of the object (e.g., a file system or snapsho | prn(ro string): Pure Resource Name of the identity provider | services(array): Services that the OIDC SSO authentication is used

OidcSsoPatch: enabled(boolean): If set to true, the OIDC SSO configuration is en | idp(object): Identity Provider | name(string): A new name for the provider | prn(ro string): Pure Resource Name of the identity provider | services(array): Services that the OIDC SSO authentication is used

OidcSsoPost: enabled(boolean): If set to true, the OIDC SSO configuration is en | idp(object): Identity Provider | prn(ro string): Pure Resource Name of the identity provider | services(array): Services that the OIDC SSO authentication is used

PageInfoScale: continuation_token(string): Continuation token that can be provided in the co | more_items_remaining(boolean): Returns a value of trueif subsequent items can |total_item_count(integer): Total number of items after applying filter` para

PasswordPolicy: enabled(boolean): If true, the policy is enabled. If not specified | enforce_dictionary_check(boolean): If true, test password against dictionary of kno | enforce_username_check(boolean): If true, the username cannot be a substring of t | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | lockout_duration(integer): The lockout duration, in milliseconds, if a user i | max_login_attempts(integer): Maximum number of failed login attempts allowed be | max_password_age(integer): The maximum age of password before password change | min_character_groups(integer): The minimum number of character groups ([a-z], [A- | min_characters_per_group(integer): The minimum number of characters per group to coun | min_password_age(integer): The minimum age, in milliseconds, of password befo | min_password_length(integer): Minimum password length. If not specified, default | name(string): A user-specified name. The name must be locally un | password_history(integer): The number of passwords tracked to prevent reuse o | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

Policy: context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | retention_lock(ro string): If retention lock is locked, then the the policy c | rules(array):

PolicyBase: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

PolicyBaseContext: context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

PolicyBaseRenameable: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

PolicyFileSystemSnapshot: context(ro object): The context in which the operation was performed. | member(object): Reference to the resource the policy is applied to | policy(object): Reference to the policy.

PolicyMemberContext: context(ro object): The context in which the operation was performed. | member(object): Reference to the resource the policy is applied to | policy(object): Reference to the policy.

PolicyMemberWithRemote: context(ro object): The context in which the operation was performed. | link(object): Only populated if the member is a file system re | member(object): Reference to the resource the policy is applied to | policy(object): Reference to the policy.

PolicyPost: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | retention_lock(ro string): If retention lock is locked, then the the policy c | rules(array):

PolicyRuleObjectAccess: actions(array): The list of actions granted by this rule. Each inc | conditions(object): Conditions used to limit the scope which this rule | context(ro object): The context in which the operation was performed. | effect(ro string): Effect of this rule. When allow, the rule allows | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | resources(array): The list of resources which this rule applies to.

PolicyRuleObjectAccessBulkManage: actions(array): The list of actions granted by this rule. Each inc | conditions(object): Conditions used to limit the scope which this rule | effect(string): Effect of this rule. When allow, the rule allows | name(string): Name of the object (e.g., a file system or snapsho | resources(array): The list of resources which this rule applies to.

PolicyRuleObjectAccessPost: actions(array): The list of actions granted by this rule. Each inc | conditions(object): Conditions used to limit the scope which this rule | effect(string): Effect of this rule. When allow, the rule allows | resources(array): The list of resources which this rule applies to.

PublicKey: algorithm(ro string): The cryptographic algorithm used by the key. Valid | id(ro string): A globally unique, system-generated ID. The ID can | key_size(ro integer): The size of the public key in bits. | name(string): A user-specified name. The name must be locally un | public_key(string): The text of the public key. May be PEM-formatted o

PublicKeyUse: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | use(object): A reference to an object using this public key.

QosPolicy: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | max_total_bytes_per_sec(integer): The maximum allowed bytes/s totaled across all the | max_total_ops_per_sec(integer): The maximum allowed operations/s totaled across al | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy.

QuotaSetting: contact(string): The contact information that will be provided in a | direct_notifications_enabled(boolean): Are notifications regarding space usage and quotas | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho

Realm: created(ro integer): Creation timestamp of the realm. | default_inbound_tls_policy(object): The default TLS policy governing inbound traffic f | destroyed(boolean): Returns a value of true if the realm has been de | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | space(object): The space usage of the realm. | time_remaining(ro integer): Time in milliseconds before the realm is eradicate

RealmDefaults: context(ro object): The context in which the operation was performed. | object_store(array): Default configurations for object store. | realm(ro object): Realm for the defaults.

RealmPatch: default_inbound_tls_policy(object): The default TLS policy governing inbound traffic f | destroyed(boolean): Returns a value of true if the realm has been de | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un

RealmSpace: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | space(object): | time(integer): Sample time in milliseconds since UNIX epoch.

RealmSpaceStorageClass: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | space(object): | storage_class(string): The name of the storage-class. | time(integer): Sample time in milliseconds since UNIX epoch.

RelationshipPerformanceReplication: aggregate(object): Total bytes transmitted or received per second for | context(ro object): The context in which the operation was performed. | continuous(object): Object backlog information and total bytes transmi | id(ro string): A non-modifiable, globally unique ID chosen by the | periodic(object): Total bytes transmitted or received per second for | time(ro integer): Sample time in milliseconds since UNIX epoch.

RemoteArray: api_versions(array): A list of supported API versions. | fleet(object): | id(ro string): A globally unique, system-generated ID. The ID can | is_local(boolean): If set to true, this array is the current array. | model(string): Specifies the array model. | name(string): A user-specified name. The name must be locally un | os(string): Specifies the operating system. Valid values are |version`(string): Specifies the operating system version.

ResourceAccess: id(ro string): A non-modifiable, globally unique ID chosen by the | resource(object): Resource to which the scope has access to. | scope(object): Scope which has access to the resource.

ResourcePerformanceReplication: aggregate(object): Total bytes transmitted or received per second for | continuous(object): Object backlog information and total bytes transmi | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | periodic(object): Total bytes transmitted or received per second for | time(ro integer): Sample time in milliseconds since UNIX epoch.

Role: id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | permissions(array): A list of permissions that the role can perform.

S3ExportPolicy: context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array):

S3ExportPolicyPatch: enabled(boolean): | name(string): New name of the S3 export policy. | rules(array):

S3ExportPolicyRule: actions(array): The list of actions granted by this rule. Each inc | context(ro object): The context in which the operation was performed. | effect(string): Effect of this rule. When allow, the rule allows | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | resources(array): The list of resources from the account to which th

S3ExportPolicyRulePost: actions(array): The list of actions granted by this rule. Each inc | effect(string): Effect of this rule. When allow, the rule allows | resources(array): The list of resources from the account to which th

Saml2Sso: array_url(string): The URL of the array. | binding(string): SAML2 binding to use for the request from Flashbla | enabled(boolean): If set to true, the SAML2 SSO configuration is e | id(ro string): A globally unique, system-generated ID. The ID can | idp(object): Properties specific to the identity provider. | name(string): A user-specified name. The name must be locally un | prn(ro string): Pure Resource Name of the identity provider | services(array): Services that the SAML2 SSO authentication is used | sp(object):

Saml2SsoPost: array_url(string): The URL of the array. | binding(string): SAML2 binding to use for the request from Flashbla | enabled(boolean): If set to true, the SAML2 SSO configuration is e | idp(object): Properties specific to the identity provider. | prn(ro string): Pure Resource Name of the identity provider | services(array): Services that the SAML2 SSO authentication is used | sp(object):

Server: created(ro integer): Creation timestamp of the server. | directory_services(ro array): The directory service config to be used by this se | dns(array): The DNS config to be used by this server. | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | realms(ro array): The realms containing this server.

ServerContext: context(ro object): The context in which the operation was performed. | created(ro integer): Creation timestamp of the server. | directory_services(ro array): The directory service config to be used by this se | dns(array): The DNS config to be used by this server. | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | realms(ro array): The realms containing this server.

Session: end_time(ro integer): Date and time the user logged out of the Purity//F | event(ro string): Description of session events. Valid values includ | event_count(ro integer): Number of session events. | id(ro string): A non-modifiable, globally unique ID chosen by the | identifying_details(ro string): Additional details, depending on the authenticatio | location(ro string): IP address of the user client connecting to the ar | method(ro string): Method by which the user attempted to log in. Vali | name(ro string): Name of the object (e.g., a file system or snapsho | start_time(ro integer): Date and time the user logged in to the Purity//FB | user(ro string): Username of the Purity//FB user who triggered the | user_interface(ro string): The user interface through which the user session

SmbClientPolicy: access_based_enumeration_enabled(boolean): If set to true, enables access based enumeration | context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy. The | version(ro string): A hash of the other properties of this resource. T

SmbClientPolicyPatch: access_based_enumeration_enabled(boolean): If set to true, enables access based enumeration | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy. The | version(ro string): A hash of the other properties of this resource. T

SmbClientPolicyPost: access_based_enumeration_enabled(boolean): If set to true, enables access based enumeration | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy. The

SmbClientPolicyRule: client(string): Specifies the clients that will be permitted to ac | context(ro object): The context in which the operation was performed. | encryption(string): Specifies whether the remote client is required to | id(ro string): A non-modifiable, globally unique ID chosen by the | index(integer): The index within the policy. The index indicates | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio | policy(object): The policy to which this rule belongs. | policy_version(ro string): The policy's version. This can be used when updati

SmbClientPolicyRuleBase: client(string): Specifies the clients that will be permitted to ac | encryption(string): Specifies whether the remote client is required to | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio | policy(object): The policy to which this rule belongs. | policy_version(ro string): The policy's version. This can be used when updati

SmbClientPolicyRuleInPolicy: client(string): Specifies the clients that will be permitted to ac | encryption(string): Specifies whether the remote client is required to | id(ro string): A non-modifiable, globally unique ID chosen by the | index(ro integer): The index within the policy. The index indicates | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio | policy(object): The policy to which this rule belongs. | policy_version(ro string): The policy's version. This can be used when updati

SmbClientPolicyRulePost: client(string): Specifies the clients that will be permitted to ac | encryption(string): Specifies whether the remote client is required to | id(ro string): A non-modifiable, globally unique ID chosen by the | index(integer): The index within the policy. The index indicates | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio

SmbClientPolicyRulePostBase: client(string): Specifies the clients that will be permitted to ac | encryption(string): Specifies whether the remote client is required to | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio

SmbClientPolicyRulePostInPolicy: client(string): Specifies the clients that will be permitted to ac | encryption(string): Specifies whether the remote client is required to | id(ro string): A non-modifiable, globally unique ID chosen by the | index(ro integer): The index within the policy. The index indicates | name(ro string): Name of the object (e.g., a file system or snapsho | permission(string): Specifies which read-write client access permissio

SmbSharePolicy: context(ro object): The context in which the operation was performed. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy.

SmbSharePolicyPatch: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy.

SmbSharePolicyPost: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | rules(array): All of the rules that are part of this policy.

SmbSharePolicyRule: change(string): The state of the principal's Change access permiss | full_control(string): The state of the principal's Full Control access p | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | principal(string): The user or group who is the subject of this rule, | read(string): The state of the principal's Read access permissio

SmbSharePolicyRulePost: change(string): The state of the principal's Change access permiss | full_control(string): The state of the principal's Full Control access p | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | principal(string): The user or group who is the subject of this rule, | read(string): The state of the principal's Read access permissio

SmbSharePolicyRuleWithContext: change(string): The state of the principal's Change access permiss | context(ro object): The context in which the operation was performed. | full_control(string): The state of the principal's Full Control access p | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | principal(string): The user or group who is the subject of this rule, | read(string): The state of the principal's Read access permissio

SmtpServer: encryption_mode(string): Enforces an encryption mode when sending alert ema | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | relay_host(string): Relay server used as a forwarding point for email | sender_domain(string): Domain name appended to alert email messages.

SnapshotPolicyPatch: add_rules(array): | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(ro string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include snapshot | realms(ro array): Reference to the realms this resource belongs to. | remove_rules(array): | retention_lock(ro string): If retention lock is locked, then the the policy c | rules`(array):

SnapshotWormDataPolicyBase: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(ro string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include snapshot | realms`(ro array): Reference to the realms this resource belongs to.

SnmpAgent: engine_id(ro string): An SNMP agent's adminstration domain unique name. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | v2c(object): The v2c configurations of SNMP. | v3(object): The v3 configurations of SNMP. | version(string): Version of the SNMP protocol to be used by an SNMP

SnmpManager: host(string): DNS hostname or IP address of a computer that host | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | notification(string): The type of notification the agent will send. Vali | v2c(object): The v2c configurations of SNMP. | v3(object): The v3 configurations of SNMP. | version(string): Version of the SNMP protocol to be used by Purity

SnmpManagerPost: host(string): DNS hostname or IP address of a computer that host | notification(string): The type of notification the agent will send. Vali | v2c(object): The v2c configurations of SNMP. | v3(object): The v3 configurations of SNMP. | version(string): Version of the SNMP protocol to be used by Purity

SoftwareCheck: checks(array): A list of checks in this check task. | details(string): The detailed reason for the status. | end_time(integer): End time in milliseconds since the UNIX epoch. | id(ro string): A globally unique, system-generated ID. The ID can | name(ro string): Name of the resource. The name cannot be modified. | software_name(string): The name of the software the upgrade checks will t | software_upgrade_hops(array): The list of software versions the upgrade goes thr | software_version(string): The version of the software that the upgrade check | start_time(integer): Start time in milliseconds since the UNIX epoch. | status(string): The status of the check task. Valid values are `qu

SshCertificateAuthorityPolicy: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | signing_authority(object): A reference to the authority that will digitally s | static_authorized_principals(array): If not specified - users affected by this policy c

SshCertificateAuthorityPolicyPost: enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | signing_authority(object): A reference to the authority that will digitally s | static_authorized_principals(array): If not specified - users affected by this policy c

StorageClassInfo: name(string): | status(ro string): The status of the transition from the policy to th | status_details(ro string): Additional details about the status of the transit | tiering_policy(object): The storage class tiering policy defines tiering f

StorageClassSpace: capacity(integer): Usable capacity in bytes. | name(ro string): | space(object): | time(integer): Sample time in milliseconds since UNIX epoch.

StorageClassTieringPolicy: archival_rules(array): The list of archival rules for this policy. | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | retrieval_rules(array): The list of retrieval rules for this policy.

Subnet: enabled(ro boolean): Indicates if subnet is enabled (true) or disable | gateway(string): The IPv4 or IPv6 address of the gateway through wh | id(ro string): A non-modifiable, globally unique ID chosen by the | interfaces(ro array): List of network interfaces associated with this su | link_aggregation_group(object): Reference to the associated LAG. | mtu(integer): Maximum message transfer unit (packet) size for th | name(ro string): Name of the object (e.g., a file system or snapsho | prefix(string): The IPv4 or IPv6 address to be associated with the | services(ro array): The services provided by this subnet, as inherited | vlan(integer): VLAN ID.

Support: 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. | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho | 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): Specifies the duration of the remote-assist sessio | remote_assist_expires(ro string): The time when the session expires. | remote_assist_opened(ro string): The time when the session opened. | remote_assist_paths(ro array): | remote_assist_status(ro string): The status of the remote-assist sessions. Valid va

SupportDiagnostics: analysis_period(object): A resource with a start time and end time. | id(ro string): A non-modifiable, globally unique ID chosen by the | index(ro integer): The unique index of the task. | name(ro string): Name of the object (e.g., a file system or snapsho | severity_count(array): List of severity counts. | start_time(integer): Start time in milliseconds since the UNIX epoch. | status(string): Status of the diagnostics. A status of running i | task_id(ro string): A globally unique, system-generated ID. The ID can | version(string): Version of diagnostics tool.

SupportDiagnosticsDetails: id(ro string): A non-modifiable, globally unique ID chosen by the | index(ro number): The unique index of the test. It will be of the fo | name(ro string): Name of the object (e.g., a file system or snapsho | result_details(string): More details related to the test. This field can p | severity(string): Severity level of the test. Valid values include |task_id(ro string): The task ID of the diagnostics for which this refe | test_name(string): Name of the test that was performed. | test_type`(string): Category to which the test belongs to.

SyslogServer: id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | services(array): Valid values are data-audit and management. If | sources(array): The network interfaces used for communication with | uri(string): The URI of the syslog server in the format PROTOCO

SyslogServerContext: context(ro object): The context in which the operation was performed. | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | services(array): Valid values are data-audit and management. If | sources(array): The network interfaces used for communication with | uri(string): The URI of the syslog server in the format PROTOCO

SyslogServerPatch: services(array): Valid values are data-audit and management. | sources(array): The network interfaces used for communication with | uri(string): The URI of the syslog server in the format PROTOCO

SyslogServerPost: services(array): Valid values are data-audit and management. If | sources(array): The network interfaces used for communication with | uri(string): The URI of the syslog server in the format PROTOCO

SyslogServerSettings: ca_certificate(object): | ca_certificate_group(object): | id(ro string): A non-modifiable, globally unique ID chosen by the | name(ro string): Name of the object (e.g., a file system or snapsho

Target: address(string): IP address or FQDN of the target system. | ca_certificate_group(object): The group of CA certificates that can be used, in | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | status(ro string): Status of the connection. Valid values are connec | status_details`(ro string): Additional information describing any issues encou

TargetWithContext: address(string): IP address or FQDN of the target system. | ca_certificate_group(object): The group of CA certificates that can be used, in | context(ro object): The context in which the operation was performed. | id(ro string): A globally unique, system-generated ID. The ID can | name(string): A user-specified name. The name must be locally un | status(ro string): Status of the connection. Valid values are connec | status_details`(ro string): Additional information describing any issues encou

TestResult: component_address(string): Address of the component running the test. | component_name(string): Name of the component running the test. | description(string): What the test is doing. | destination(string): The URI of the target server being tested. | enabled(boolean): Is the service enabled or not? | resource(object): A reference to the object being tested. | result_details(string): Additional information about the test result. | success(boolean): Returns a value of true if the specified test su | test_type(string): Displays the type of test being performed. The ret

TieringPolicyArchivalRule: target_storage_class(ro string): The storage class to which the data is moved. Will | time(integer): The time at which this rule goes into effect, in m | type(string): The type of the archival rule determining when to

TlsPolicy: appliance_certificate(object): A reference to a certificate that will be presente | client_certificates_required(boolean): If true, then all clients negotiating TLS connec | disabled_tls_ciphers(array): If specified, disables the specific TLS ciphers. I | enabled(boolean): If true, the policy is enabled. If not specified | enabled_tls_ciphers(array): If specified, enables only the specified TLS ciphe | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | min_tls_version(string): The minimum TLS version that will be allowed for i | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | trusted_client_certificate_authority(object): A reference to a certificate or certificate group. | verify_client_certificate_trust(boolean): If true, then any certificate presented by a cli

TlsPolicyPost: appliance_certificate(object): A reference to a certificate that will be presente | client_certificates_required(boolean): If true, then all clients negotiating TLS connec | disabled_tls_ciphers(array): If specified, disables the specific TLS ciphers. I | enabled(boolean): If true, the policy is enabled. If not specified | enabled_tls_ciphers(array): If specified, enables only the specified TLS ciphe | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | min_tls_version(string): The minimum TLS version that will be allowed for i | name(string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include alert, | realms(ro array): The realms containing this policy. | trusted_client_certificate_authority(object): A reference to a certificate or certificate group. | verify_client_certificate_trust(boolean): If true, then any certificate presented by a cli

TrustPolicyRule: actions(array): The list of role-assumption actions granted by thi | conditions(array): Conditions used to limit the scope which this rule | effect(ro string): Effect of this rule. When allow, the rule allows | index(ro integer): Index of the object in the containing array. | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | principals(array): List of Identity Providers

TrustPolicyRulePost: actions(array): The list of role-assumption actions granted by thi | conditions(array): Conditions used to limit the scope which this rule | effect(ro string): Effect of this rule. When allow, the rule allows | policy(object): The policy to which this rule belongs. | principals(array): List of Identity Providers

TrustPolicyRuleWithContext: actions(array): The list of role-assumption actions granted by thi | conditions(array): Conditions used to limit the scope which this rule | context(ro object): The context in which the operation was performed. | effect(ro string): Effect of this rule. When allow, the rule allows | index(ro integer): Index of the object in the containing array. | name(ro string): Name of the object (e.g., a file system or snapsho | policy(object): The policy to which this rule belongs. | principals(array): List of Identity Providers

UserQuota: context(ro object): The context in which the operation was performed. | file_system(object): | file_system_default_quota(ro integer): File system's default user quota (in bytes). If it | name(ro string): Name of the object (e.g., a file system or snapsho | quota(integer): The limit of the quota (in bytes) for the specifie | usage(ro integer): The usage of the file system (in bytes) by the spe | user(object): The user on which this quota is enforced.

VerificationKey: key_id(integer): The key id of the verification key. | name(string): Name of the verification key. Possible values incl | verification_key(string): The text of the verification key.

WormDataPolicy: context(ro object): The context in which the operation was performed. | default_retention(integer): Default retention period, in milliseconds. If the | enabled(boolean): If true, the policy is enabled. If not specified | id(ro string): A globally unique, system-generated ID. The ID can | is_local(ro boolean): Whether the policy is defined on the local array. | location(object): Reference to the array where the policy is defined | max_retention(integer): Maximum retention period, in milliseconds. | min_retention(integer): Minimum retention period, in milliseconds. | mode(string): The type of the retention lock. Valid values is c | name(ro string): A user-specified name. The name must be locally un | policy_type(ro string): Type of the policy. Valid values include snapshot | realms(ro array): The realms containing this worm data policy. | retention_lock(string): If set to locked, then the value of retention at

FilesExpand file tree

FLASHBLADE_API.md

Latest commit

History