Get

/views/{id}/

This endpoint returns details of a view.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

The ID of the view to show

Responses

200

Expand All

object

id

integer

title

string

ignore_oos

boolean

internal

boolean

guid

string

name

string

created

string (date-time)

path

string

The Element Store path exposed by the view. Begin with a forward slash. Do not include a trailing slash

create_dir

string

Creates the directory specified by the path

alias

string

Alias for NFS export, must start with '/' and only ASCII characters are allowed. If configured, this supersedes the exposed NFS export path

allowed_delegations

string

Which types of NFSv4 file delegations are enabled for this view.

NONE means NFSv4 file delegations are disabled.
READ means read type NFSv4 file delegations can be granted to a client opening a file.
WRITE means write type NFSv4 file delegations can be granted to a client opening a file.
READ_WRITE means both read and write type NFSv4 file delegations can be granted to a client opening a file.
USE_TENANT_ALLOWED_DELEG (default) means the view inherits the tenant’s allowed_delegations.

Important: If the tenant has DISABLED delegations, this overrides the view entirely. The effective delegations value for this view is forced to NONE, regardless of the view’s setting.

Valid values[ "NONE", "READ", "WRITE", "READ_WRITE", "USE_TENANT_ALLOWED_DELEG" ]

effective_allowed_delegations

string

The resolved NFSv4 delegation type that applies to the View.

Resolution rules:

If the tenant's allowed delegations is DISABLED, the effective value is forced to NONE.
Otherwise, if allowed_delegations is USE_TENANT_ALLOWED_DELEG, the value is inherited from the Tenant's allowed_delegations.
In all other cases, the effective value equals this object's own allowed_delegations.

This field shows the final delegation behavior observed by clients.

Valid values[ "NONE", "READ", "WRITE", "READ_WRITE" ]

has_nfs4_triggers

boolean

Whether NFSv4 triggers are currently enabled for this view

bucket

string

S3 Bucket name

s3_object_ownership_rule

string

policy

string

The name of the associated view policy

policy_id

integer

The ID of the associated view policy

cluster

string

Parent Cluster

cluster_id

integer

Parent Cluster ID

tenant_id

integer

Tenant ID

tenant_name

string

Tenant Name

url

string

The endpoint URL for API operations on the view

directory

boolean

Create the directory if it does not exist

s3_versioning

boolean

S3 Versioning enabled on S3 bucket.

s3_unverified_lookup

boolean

S3 Unverified Lookup

allow_anonymous_access

boolean

Allow S3 anonymous access

allow_s3_anonymous_access

boolean

Allow S3 anonymous access

protocols

Array of string

Protocols enabled for access to the view. 'NFS' enables access from NFS version 3, 'NFS4' enables access from NFS version 4.1 and 4.2, S3' creates an S3 bucket on the view, 'ENDPOINT' creates an S3 endpoint, used as template for views created via S3 RPCs, DATABASE exposes the view as a VAST database. KAFKA enables events related to elements on the view path to be published to the VAST Event Broker. BLOCK exposes the view as a block storage subsystem."

Valid values[ "NFS", "SMB", "NFS4", "S3", "ENDPOINT", "DATABASE", "KAFKA", "BLOCK" ]

string

abac_tags

Array of string

Comma separated tags.

string

share

string

Name of the SMB share. Must not include certain special characters.

sync

string

Synchronization state with leader

sync_time

string

Synchronization time with leader

bucket_owner

string

S3 Bucket owner

bucket_owner_type

string

Specifies whether the bucket owner is a user (USER) or a IAM role (ROLE). The default is USER.

Valid values[ "USER", "ROLE" ]

bucket_creators

Array of string

For S3 endpoint buckets, this is a list of users whose bucket create requests use this view.

string

bucket_creators_groups

Array of string

For S3 endpoint buckets, this is a list of groups whose bucket create requests use this view.

string

locking

boolean

Write Once Read Many (WORM) locking enabled

s3_locks_retention_mode

string

The retention mode for new object versions stored in this bucket. You can override this if you upload a new object version with an explicit retention mode and period.

Valid values[ "NONE", "GOVERNANCE", "COMPLIANCE" ]

default_retention_period

string

Default retention period for objects in the bucket. Required if s3_locks_retention_mode is set to governance or compliance. Object versions that are placed in the bucket are automatically protected with the specified retention for the specified amount of time. Otherwise, by default, each object version has no automatic protection but can be configured with a retention period or legal hold. Specify as an integer followed by h for hours, d for days, m for months, or y for years. For example: 2d or 1y.

physical_capacity

integer

Physical Capacity consumed by view

logical_capacity

integer

Logical Capacity consumed by view

is_remote

boolean

share_acl

object

Share-level ACL details

enabled

boolean

True if Share ACL is enabled on the view, otherwise False

acl

Array of object

Share-level ACL

object

Share-level ACE

fqdn

string

FQDN of the chosen grantee

name

string

name of the chosen grantee

perm

string

Grantee’s permissions

Valid values[ "FULL", "CHANGE", "READ" ]

grantee

string

grantee type

Valid values[ "users", "groups" ]

sid_str

string

grantee’s SID

uid_or_gid

integer

grantee’s uid (if user) or gid (if group)

select_for_live_monitoring

boolean

True when the view has live monitoring enabled. Views that have live monitoring enabled are polled for metrics every ten seconds. Otherwise, views are polled every five minutes.

qos_policy_id

integer

QoS Policy ID

qos_policy

string

QoS Policy

bulk_permission_update_state

string

State

bulk_permission_update_progress

integer

Progress

abe_protocols

Array of string

The protocols for which Access-Based Enumeration (ABE) is enabled

string

Valid values[ "NFS", "SMB", "NFS4", "S3" ]

abe_max_depth

integer

Restricts ABE to a specified path depth. For example, if max depth is 3, ABE does not affect paths deeper than three levels. If not specified, ABE affects all path depths.

is_seamless

boolean

Supports seamless failover between replication peers by syncing file handles between the view and remote views on the replicated path on replication peers. This enables NFSv3 client users to retain the same mount point to the view in the event of a failover of the view path to a replication peer. This feature enables NFSv3 client users to retain the same mount point to the view in the event of a failover of the view path to a replication peer. Enabling this option may cause overhead and should only be enabled when the use case is relevant. To complete the configuration for seamless failover between any two peers, a seamless view must be created on each peer.

files_retention_mode

string

Applicable if locking is enabled. The retention mode for new files. For views enabled for NFSv3 or SMB, if locking is enabled, files_retention_mode must be set to GOVERNANCE or COMPLIANCE. If the view is enabled for S3 and not for NFSv3 or SMB, files_retention_mode can be set to NONE. If GOVERNANCE, locked files cannot be deleted or changed. The Retention settings can be shortened or extended by users with sufficient permissions. If COMPLIANCE, locked files cannot be deleted or changed. Retention settings can be extended, but not shortened, by users with sufficient permissions. If NONE (S3 only), the retention mode is not set for the view; it is set individually for each object.

Valid values[ "NONE", "GOVERNANCE", "COMPLIANCE" ]

max_retention_period

string

Applicable if locking is enabled. Sets a maximum retention period for files that are locked in the view. Files cannot be locked for longer than this period, whether they are locked manually (by setting the atime) or automatically, using auto-commit. Specify as an integer value followed by a letter for the unit (m - minutes, h - hours, d - days, y - years). Example: 2y (2 years).

min_retention_period

string

Applicable if locking is enabled. Sets a minimum retention period for files that are locked in the view. Files cannot be locked for less than this period, whether locked manually (by setting the atime) or automatically, using auto-commit. Specify as an integer value followed by a letter for the unit (h - hours, d - days, m - months, y - years). Example: 1d (1 day).

auto_commit

string

Applicable if locking is enabled. Sets the auto-commit time for files that are locked automatically. These files are locked automatically after the auto-commit period elapses from the time the file is saved. Files locked automatically are locked for the default-retention-period, after which they are unlocked. Specify as an integer value followed by a letter for the unit (h - hours, d - days, y - years). Example: 2h (2 hours).

bucket_logging

object

S3 bucket logging configuration. S3 bucket logging records S3 operations on a source bucket, with logs written to a different bucket configured as the destination. When the source bucket has S3 bucket logging enabled, VAST Cluster creates a log entry in AWS log format for each request made to the source bucket, and periodically uploads the log objects to a destination bucket. The format of log object keys can be configured to allow for date-based partitioning of log objects.

destination_id

integer

The ID of the S3 bucket view configured as the bucket logging destination, to store S3 bucket logs for the view. If destination_id is configured, S3 bucket logging is enabled.

prefix

string

A prefix that is prepended to each key of a log object uploaded to the destination bucket. This prefix can be used to categorize log objects if, for example, you use the same destination bucket for multiple source buckets. The prefix can be up to 128 characters and must follow S3 object naming rules.

key_format

string

The format for log object keys. SIMPLE_PREFIX=[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString], PARTITIONED_PREFIX_EVENT_TIME=[DestinationPrefix][SourceUsername]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString] where the partitioning is done based on the time when the logged events occurred, PARTITIONED_PREFIX_DELIVERY_TIME=[DestinationPrefix][SourceUsername]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString] where the partitioning is done based on the time when the log object has been delivered to the destination bucket. Default: SIMPLE_PREFIX

Valid values[ "SIMPLE_PREFIX", "PARTITIONED_PREFIX_EVENT_TIME", "PARTITIONED_PREFIX_DELIVERY_TIME" ]

has_bucket_logging_sources

boolean

Is referenced by other S3 bucket views as the destination bucket for S3 bucket logging.

has_bucket_logging_destination

boolean

Has a destination bucket configured as a destination for S3 bucket logging

event_notifications

Array of object (EventNotification)

object

S3 bucket Event Notification

name

string

Event unique name

broker_id

integer

Event broker ID

topic

string

Event topic

triggers

Array of string

Event triggers

string

Valid values[ "S3_OBJECT_CREATED_ALL", "S3_OBJECT_CREATED_PUT", "S3_OBJECT_CREATED_POST", "S3_OBJECT_CREATED_COPY", "S3_OBJECT_CREATED_COMPLETE_MULTIPART_UPLOAD", "S3_OBJECT_REMOVED_ALL", "S3_OBJECT_REMOVED_DELETE", "S3_OBJECT_REMOVED_DELETE_MARKER_CREATED", "S3_OBJECT_TAGGING_ALL", "S3_OBJECT_TAGGING_PUT", "S3_OBJECT_TAGGING_DELETE" ]

prefix_filter

string

Event prefix filter

suffix_filter

string

Event suffix filter

kafka_vip_pools

Array of integer

For Kafka-enabled views, a comma separated list of vip pool IDs used to access event topics exposed by the view. The specified virtual IP pool must belong to the same tenant as the Kafka-enabled view. Must also not be a virtual IP pool that is excluded by the view policy's virtual IP pool association.

integer

kafka_rejoin_group_timeout_sec

integer

The maximum allowed session timeout, in seconds, for registered consumers. Valid values are 1-3600. The default value is 60.

kafka_first_join_group_timeout_sec

integer

The amount of time, in seconds, to wait for more consumers to join a new group before performing the first rebalance. Valid values are 1-3600. The default value is 60.

is_indestructible_object_enabled

boolean

True if indestructible object mode is enabled.

indestructible_object_duration

integer

Retention period for indestructible object mode, in days.

user_impersonation

object (UserImpersonation)

username

string

The username of the user to impersonate

enabled

boolean

True if user impersonation is enabled

identifier

string

Identifier of the user to impersonate

identifier_type

string

The identifier type of the specified identifier.

Valid values[ "uid_or_gid", "uid", "vid", "sid_str", "login_name", "username" ]

login_name

string

Full username of user to impersonate, including domain name

is_default_subsystem

boolean

True if the view is the default subsystem for block storage. There can be up to one default subsystem per tenant. The default subsystem is the default view selected when creating a block volume if no view is specified.

nqn

string

Applicable to subsystem (block protocol enabled) views. The subsystem's NVMe Qualified Name. A unique identifier used to identify the subsystem in NVMe operations.

smb_encryption_state

string

If the tenant has SMB encryption enabled, this property sets the view's SMB encryption protection to a value that is equal to or stronger than that of the tenant. AVAILABLE=Encryption is used only for SMB clients which have requested it explicitly. For clients that do not support encryption, access is allowed but no encryption is used. DESIRED=The cluster uses encryption for any SMB client that supports encryption. For clients that do not support encryption, access is allowed but no encryption is used., REQUIRED=SMB clients that do not support encryption are denied access.

Valid values[ "OFF", "AVAILABLE", "DESIRED", "REQUIRED" ]

is_kafka_unencrypted_conn_allowed

boolean

True if unencrypted connection is allowed for a Kafka-enabled view. Enables authentication of clients that use non-TLS connections to access the Kafka-enabled view.

kafka_unencrypted_auth_mechanism

string

Authentication mechanism enabled on unencrypted connections to Kafka-enabled views. Applies if is_kafka_unencrypted_conn_allowed is enabled. Specify SASL_PLAIN to enable SASL plain authentication on non-TLS connections to a Kafka-enabled view.

Valid values[ "NONE", "SASL_PLAIN", "MTLS" ]

is_kafka_encrypted_conn_allowed

boolean

True if encrypted connection is allowed for a Kafka-enabled view. Enables authentication of clients that use TLS connections to access a Kafka-enabled view. This option requires a Kafka TLS certificate to be provided for the VAST cluster.

kafka_encrypted_auth_mechanism

string

Authentication mechanism enabled on encrypted connections to Kafka-enabled views. Applies if is_kafka_encrypted_conn_allowed is enabled. Specify SASL_PLAIN to enable SASL plain authentication on TLS connections to a Kafka-enabled view.

Valid values[ "NONE", "SASL_PLAIN", "MTLS" ]

kafka_is_authorization_required

boolean

True if authorization is required for clients connecting to a Kafka-enabled view.

Return Details of a View