> ## Documentation Index > Fetch the complete documentation index at: https://kb.vastdata.com/llms.txt > Use this file to discover all available pages before exploring further. # Deletes NLM Locks > This endpoint deletes NLM locks on a file. ## OpenAPI ````json DELETE /clusters/{id}/locks/ { "openapi": "3.0.1", "info": { "title": "VAST API Swagger Schema", "description": "VAST Management Service API definition", "version": "1.0" }, "security": [ { "basicAuth": [] }, { "ApiToken": [] } ], "tags": [ { "name": "User Management > Active Directory", "description": "Active Directory is supported as an external authorization and authentication provider. Active Directory may store and provide user and group attributes used by both NFS and SMB protocols. Active Directory can be used to enable Kerberos authentication with NFSv4 and with SMB. It is a requirement for enabling SMB access on VAST Cluster. Up to one Active Directory domain is supported. The configuration must specify an LDAP configuration for binding to the LDAP domain of the Active Directory server. Limitations apply to the combinations of external providers and protocol enablement." }, { "name": "Analytics > Analytics", "description": "Metrics available to be included in analytics reports (using the /monitors/ endpoint) can be listed using either the /metrics/ endpoint or the /analytics/ endpoint." }, { "name": "Alarms and Events > Alarms", "description": "Alarms can be raised by events." }, { "name": "Authentication > API Tokens", "description": "API tokens are tokens created by VMS that enable VMS users to securely authenticate REST API requests." }, { "name": "Administrators > Basic Settings", "description": "This endpoint provides basic settings for users that do not have permissions to access any security realm.\"" }, { "name": "Network Access and Security > BGP Configs", "description": "BGP Configs are Border Gateway Protocol (BGP) configurations. You can configure a virtual IP pool to use layer 3 connectivity, instead of the default layer 2 connectivity, by attaching a BGP configuration to the Virtual IP pool." }, { "name": "Database > Blob Expansions", "description": "Blob Expansions are event parsing configurations that map fields from incoming Kafka events onto a target cluster table." }, { "name": "Element Store > Block Hosts", "description": "Block Hosts are block storage client hosts. They must be added to VMS in order to enable block storage volumes to be made available to them." }, { "name": "Element Store > Block Mappings", "description": "Block Mappings are mappings of Blockhosts to Volumes. They make block storage volumes available to block storage hosts." }, { "name": "Database > VAST Catalog - bigcatalogconfig", "description": "The bigcatalogconfig endpoint enables you to manage the configuration of VAST Catalog and to query the VAST Catalog. VAST Catalog is a database that indexes metadata attributes of all data on the cluster, enabling high performance querying of files, objects and directories based on classification of data according to attributes used by multiple access protocols. VAST catalog indexes the metadata attributes of the cluster's data from periodic snapshots of the cluster's data. The database is stored on a dedicated S3 bucket on the cluster." }, { "name": "Database > VAST Catalog - bigcatalogindexedcolumns", "description": "The bigcatalogindexedcolumns endpoint enables you to add columns to the VAST Catalog table for S3 tags and S3 metadata attributes." }, { "name": "Support > Callhome Configs", "description": "The callhomeconfigs path provides access to the cluster's Call Home configuration. Call Home is a service that sends non-sensitive data from your VAST Cluster to our central support server to enable us to provide proactive analysis and fast response on critical issues." }, { "name": "Analytics > Capacity", "description": "This endpoint enables you to query capacity details of any path on any tenant and its direct child paths.\"" }, { "name": "Infrastructure > Carriers", "description": "Carriers represent DBox slots that house SSDs and NVRAMs." }, { "name": "Infrastructure > CBoxes", "description": "A CBox is a server chassis containing four CNodes. The cboxes path represents the CBoxes in the cluster, exposes information about the cBoxes and maintenance operations." }, { "name": "Network Access and Security > Certificates", "description": "This endpoint represents certificates used to secure webhooks. See also Webhooks." }, { "name": "Data Protection > Challenge Tokens", "description": "Challenge tokens are used to unlock the cluster's indestructibility mechanism." }, { "name": "Infrastructure > Clusters", "description": "VMS manages configuration of a single VAST cluster. The clusters path provides access to many configurations and settings that apply to the cluster." }, { "name": "Database > Columns", "description": "The columns endpoint enables you to manage the columns in tables in a schema in a VAST database." }, { "name": "Infrastructure > CNodes", "description": "A CNode is a VAST server appliance or customer provided equipment running a container(s) that runs the VAST OS software, or a container running the VAST OS software. The cnodes path represents the CNodes in the cluster, exposes information about the CNodes and maintenance operations." }, { "name": "Data Engine > CNode Groups", "description": "CNode groups are groups of CNodes that managed applications can run on. See also Managed Applications." }, { "name": "Analytics > Data Flow Analytics", "description": "The iodata path provides data flow analytics." }, { "name": "DataSpace > DataSpace", "description": "The VMS web UI features a DataSpace page that provides a visually aided way to configure features that share or move data between different VAST clusters, such as replication and global namespace. This endpoint enables you to monitor DataSpace initiated tasks." }, { "name": "Infrastructure > DBoxes", "description": "A DBox is an NVMe-oF JBOF, otherwise known as a VAST enclosure, or an enclosure containing NVMe-oF controller cards and flash SSDs. The dboxes path represents the DBoxes in the cluster, exposes information about the DBoxes and maintenance operations. There are two types of DBoxes. The legacy type DBox has two DNodes. The CERES Dbox, newly introduced in some deployments, has two DTrays and four DNodes." }, { "name": "Infrastructure > DNodes", "description": "A DNode is an NVMe-oF controller card in a DBox. The dnodes path represents the DNodes in the cluster, exposes information about the DNodes and maintenance operations." }, { "name": "Infrastructure > DTrays", "description": "A DTray is a component of the CERES DBox. It is a canister that has two DNodes installed within. The DTray is a component of the CERES DBox. There are two Dtrays in each CERES DBox." }, { "name": "Network Access and Security > DNS", "description": "The DNS path represents a VAST Cluster DNS service. You can create one VAST Cluster DNS service per cluster. The VAST Cluster DNS service can distribute incoming DNS requests to specific VIP pools, according to subdomains. The service is updated of changes to VIP pool ranges. It works with a single DNS delegation record on an external DNS server." }, { "name": "Infrastructure > EBoxes", "description": "An EBox is a VAST enclosure that contains a server and SSDs. The server runs a CNode and two DNodes in containers." }, { "name": "Element Store > Encrypted Paths", "description": "An encrypted path is a path that is encrypted with a dedicated encryption group which is a subgroup of the encryption group of the tenant on which the path resides. Encrypted paths can be created on a cluster that has EKM (external key manager) encryption enabled. It is not possible to encrypt an existing path with its own encryption group." }, { "name": "Element Store > Encryption Groups", "description": "When data encryption is enabled on a VAST cluster with keys managed by an external key manager, each tenant must belong to an encryption group. Multiple tenants can belong to the same encryption group. It is also possible when creating a new path to encrypt the path with its own dedicated encryption group. This endpoint enables retrieval of encryption groups and their identifiers (CRN)." }, { "name": "Support > Envs" }, { "name": "Alarms and Events > Event Broker", "description": "The Event Broker endpoint supports operations related to external event brokers." }, { "name": "Alarms and Events > Event Definitions", "description": "Event definitions define the conditions that trigger events, the raising of alarms, alarm severity, and which actions are triggered on events, such as email notifications, webhooks and sending to syslog." }, { "name": "Alarms and Events > Event Definition Configs", "description": "The eventdefinitionconfigs path exposes event definition configurations that affect event definitions and quotas. These include default actions that apply globally to event definitions and are overridden by any conflicting settings in specific event definitions." }, { "name": "Alarms and Events > Events", "description": "VMS logs system driven events, such as changes to object states and properties, and user driven events, such as the creation, modification or deletion of any object in the system." }, { "name": "Infrastructure > Fans", "description": "Fans represent fans on the CBoxes and DBoxes" }, { "name": "Data Protection > Filesystem", "description": "This endpoint enables you to clone a given path in the Element Store to a specified destination path." }, { "name": "Element Store > Folders", "description": "The folders endpoint enables the ability to manage directories and to set and get a directory's owner user and group attributes." }, { "name": "Data Protection > Global Snapshot Streams", "description": "Global snapshot streams create instantly writable directories cloned from snapshots. Clones can be created from any snapshot residing on the cluster itself or on a cluster that has a replication peer relationship with the local cluster. The cloned directory can be from any snapshot or subtree of a snapshot, such as a snapshot replicated from a third cluster to a remote peer." }, { "name": "User Management > Groups", "description": "Groups are user groups that can be authorized to access any data on the cluster via any supported client protocol. The groups path provides: management of groups on the cluster's VAST provider, querying of external provider groups, and S3 access management for both local and external groups." }, { "name": "Administrators > S3keys", "description": "The s3keys endpoint enables users to manage their own S3 access key pairs." }, { "name": "Infrastructure > Hosts", "description": "Hosts are network discoverable CNodes and DNodes that can be included in a new cluster configuration." }, { "name": "VMS Management > Health", "description": "The Health endpoint reports VMS health state" }, { "name": "User Management > IAM Roles", "description": "IAM roles are identities that can be temporarily assumed by users. IAM roles can be granted permissions through identity policies. They can be assigned user quotas, and they can be queried." }, { "name": "Data Protection > Indestructibility", "description": "VAST Cluster enables you to create and maintain immutable backups using a feature called Indestructibility. Snapshots and protection policies can be flagged indestructible and they are then protected from accidental or malicious deletion and modification. The indestructibility path represents the configuration of the indestructibility mechanism on the cluster." }, { "name": "VMS Management > Issues", "description": "This endpoint enables you to manage issues fround in pre-installation verifications." }, { "name": "Alarms and Events > Kafka Broker", "description": "The Kafka Broker endpoint supports operations related to external event brokers. It is equivalent to the Event Broker endpoint, which is being introduced in its place for terminology reasons. Both are supported." }, { "name": "User Management > Kerberos", "description": "Kerberos providers may be independently configured on the cluster and attached to tenants. They are then available to be used to authenticate access to NFSv4 views. This is alternative to using an Active Directory Kerberos server." }, { "name": "User Management > LDAPs", "description": "Lightweight Directory Access Protocol (LDAP)-based directory servers may store and provide POSIX user and group attributes, as used by the NFS client access protocol. Up to two LDAP configurations are supported, where one is used for binding to the LDAP domain of an Active Directory server and the other is used for connecting to a different LDAP-based server other than AD. Limitations apply to the combinations of external providers and protocol enablement." }, { "name": "Support > Licenses", "description": "A license entitles the VAST Cluster operator to an amount of storage capacity for a given period from a given start time. Licenses can be aggregated to increase the licensed capacity. Operating a VAST Cluster requires an installed license. An active valid license entitles the owner to new software releases, service packs and support." }, { "name": "User Management > Local Providers", "description": "Local Providers are providers configured on the cluster, to which you can add users for authorizing access to the cluster or tenants of the cluster." }, { "name": "User Management > Local S3 Keys", "description": "Local S3 Keys are S3 access keys created for and owned by users on VAST providers." }, { "name": "Element Store > Locks", "description": "NLMv4 locks help NFSv3 clients protect NFS files from data consistency conflicts. NFS client applications can acquire read or write NLM locks on byte ranges or on whole files. VAST Cluster uses NSM to automatically remove NLM locks. Manual removal of locks should not be needed provided that every client host is configured to send sm_notify reboot notifications to NFS peers. The locks path feature can be used for manual lock removal in the event that a client OS is not configured to send sm_notify reboot notifications to NFS peers and crashes and leaves behind locks." }, { "name": "Authentication > Login", "description": "The login path is used to log into VMS." }, { "name": "Authentication > Logout", "description": "The logout path is used to log out of VMS." }, { "name": "Administrators > Managers", "description": "VAST Management System (VMS) users are called managers. A manager has login credentials and must be assigned at least one role in order to have any VMS permissions. A manager can have multiple roles." }, { "name": "Data Engine > Managed Applications", "description": "Managed applications is a feature that enables you to run 3D applications on CNodes by distributing an image across a group of CNodes." }, { "name": "Analytics > Metrics", "description": "Metrics available to be included in analytics reports (using the /monitors/ endpoint) can be listed using either the /metrics/ endpoint or the /analytics/ endpoint." }, { "name": "Support > Modules" }, { "name": "Analytics > Monitors (Analytics Reports)", "description": "Monitors are analytics reports that can provide insight into capacity utilization and cluster performance." }, { "name": "Infrastructure > NIC Ports", "description": "NIC Port failures and their causes can be detected. NIC ports can be activated and deactivated." }, { "name": "Data Protection > Replication Peers", "description": "A replication peer is a remote cluster configured as a peer for async replication. A replication peer also represents a configured and mirrored async replication relationship between two clusters." }, { "name": "Infrastructure > NICs", "description": "NICs represent interfaces on Network Interface Cards (NICs) in the CNodes and DNodes." }, { "name": "User Management > NIS", "description": "NIS is a supported external authorization provider. NIS can be used for authorizing user access to files and directories via NFS. NIS netgroups can be used to specify NFS hosts in view policies when controlling access permissions per NFS hosts. Up to one NIS configuration is supported. Limitations apply to the combinations of external providers and protocol enablement." }, { "name": "Infrastructure > NVRAMs", "description": "NVRAMs represent flash SSDs resident in DBoxes that are deployed as SCM devices, formerly known as NVRAM devices." }, { "name": "Administrators > Object Permissions", "description": "Object permissions reflect the access types, permission realms and managers associated with each object type. They can be listed but not modified." }, { "name": "User Management > OIDCs", "description": "OIDC is a web-based protocol that uses OAuth2 for authorization and adds an authentication layer. This endpoint enables you to manage external OIDC providers. These providers can be used to authenticate client users, and generate JWTs for them. These tokens can be used, in turn, by clients users to assume VAST IAM roles, and obtain S3 access keys from the VAST STS server, to access S3 buckets in the cluster." }, { "name": "Element Store > Open Files", "description": "This endpoint enables you to manage open files, including listing open handles for an open file." }, { "name": "Element Store > Open File Handles", "description": "This endpoint enables you to manage open file handles." }, { "name": "Element Store > Open File Queries", "description": "This endpoint enables you to manage open file queries." }, { "name": "Administrators > Permissions", "description": "The permissions endpoint returns permissions that can be assigned to VMS managers and roles. VMS Each permission enables a type of permission, such as create or read permission, on a realm. Each realm includes a set of resources. For example, the logical realm includes views, view policies, quotas, QoS policies and many more types of resources. The hardware realm includes infrastructure components such as CBoxes and DBoxes." }, { "name": "Infrastructure > Ports", "description": "Ports represent switch ports." }, { "name": "Database > Projections", "description": "Projections are subsets of a full table in the VAST Database that allow for optimized queries that use only the columns included in the projection." }, { "name": "Database > Projection Columns", "description": "Projection columns are columns that are included in a projection, either as the columns used to sort the projection or as additional columns included in a projection." }, { "name": "Analytics > Prometheus Metrics", "description": "prometheusmetrics is VAST's Prometheus exporter resource. Prometheus is an open-source systems monitoring and alerting toolkit that provides a data model for describing and recording metrics over time and also provides a web application to display those metrics. Prometheus can be configured to fetch metrics from a third party system (such as in this case VAST Cluster) by means of a software entity called a Prometheus exporter. A Prometheus exporter collects metrics from a third party system, converts them to Prometheus metrics and exposes them via a resource path. The VAST prometheus exporter can fetch pre-defined metrics from the VMS database and return the data as a plain/text key-value format response. You can configure the Prometheus server to scrape the metrics from the exporter at a chosen interval and display the VMS metrics through its display applications." }, { "name": "Data Protection > Protected Paths", "description": "A protected path is a data path in the Element Store (file/object system) that is protected by snapshots which may be replicated to an S3 replication peer or to an async replication peer. Scheduling and replication is controlled by an associated protection policy." }, { "name": "Data Protection > Protection Policies", "description": "A protection policy is a reusable configuration that defines a schedule for taking snapshots and optionally replicating them to a specified async replication peer or S3 replication peer. It defines how long to retain local snapshots. If the purpose of a protection policy is remote backup to either S3 or an async replication peer without local snapshot retention, then this is achieved by defining no retention for local snapshots. Once defined, a protection policy can be specified in the configuration of a protected path." }, { "name": "Infrastructure > PSUs", "description": "PSUs represent power supply units on the CBoxes and DBoxes." }, { "name": "Element Store > Quotas", "description": "A quota limits the amount of storage and/or the number of files or objects and directories that can be contained in a specified directory. A quota can include default limits on usage per user and group. It can also specify userquota objects which override default user and group limits for specified users and groups." }, { "name": "Element Store > QoS Policies", "description": "Quality of Service policies enable you to define quality of service per view. Quality of service policies can set maximum limits on read and write bandwidth and IOPS per view." }, { "name": "Element Store > Quota Entity Infos", "description": "QuotaEntityInfo objects contain details of all users and groups that wrote to quota directories. Provides VAST-internal ID from the VAST Cluster user database and email address." }, { "name": "Element Store > Quota Groups", "description": "Quota groups are groups of quotas. Limits can be defined at the quota group level. The limits apply to the set of member directories as a whole (not to each individual directory)." }, { "name": "Infrastructure > Racks", "description": "Racks are an administrative resource that you can use to reflect physical rack and stack layout in the data center. Racks can be defined at the installation and expansion stages and manually during cluster operation. CBoxes, DBoxes and EBoxes can be assigned to racks. Racks can be named and described. Unit positions in the rack can be assigned to boxes." }, { "name": "Administrators > Realms", "description": "Realms are user defined customized permission realms for VMS manager users. They define sets of object types and can be granted to managers and roles for VMS permissions." }, { "name": "Data Protection > Replication Restore Points", "description": "A replication restore point is a location to which a snapshot was replicated and from which files can be restored.A restore point may reside on an S3 replication peer or on an async replication peer." }, { "name": "Data Protection > Replication Streams", "description": "This path enables you to manage replication streams. Note that for the general case, replication streams belong to protected paths and are managed as part of protected path management. However, for the use case where you configure replication to an S3 replication peer and to an aync replication peer on the same path, use this path instead." }, { "name": "Data Protection > S3 Replication Peers", "description": "An S3 replication peer represents a specific S3 destination to which snapshots can be replicated or were replicated. S3 replication peers can be configured in order to enable replication of data to a specific S3 destination or to enable users to access restore points on the S3 replication peer via client mounts of the cluster's file system. The accessible data on the S3 replication peer may have been replicated from the local cluster or from another cluster." }, { "name": "Administrators > Roles", "description": "Roles are sets of VMS permissions. They can specify one or more LDAP groups. Mapping roles to LDAP groups gives LDAP group members the ability to log into VMS and be authorized with the aggregate of permissions belonging to all mapped roles." }, { "name": "Database > Schemas", "description": "The schemas endpoint enables you to manage the schemas in a VAST database." }, { "name": "Data Protection > Snapshots", "description": "A snapshot is an image of the data existing at a point in time under a specific Element Store path. Snapshots can be created on a one off basis or scheduled using a protected path. Scheduled snapshots can be retained locally, and/or backed up either to an S3 replication peer or to a replication peer." }, { "name": "Infrastructure > SSDs", "description": "SSDs represent flash SSDs resident in the cluster's DBoxes." }, { "name": "Network Access and Security > Subnet Manager", "description": "The subnetmanager monitors an OpenSM service. Clusters operating in larger IB networks must have an OpenSM service configured on some of the CNodes in the cluster. The OpenSM services running on those Cnodes are critical for the data network and need to be monitored. Monitoring is enabled when up to two IPs of CNodes hosting the OpenSM service are registered. The state and if applicable, failure reason, can be retrieved from the registered CNodes." }, { "name": "Support > Support Bundles", "description": "A support bundle is a compressed file consisting of logs that are extracted from the VAST Cluster. Support bundles can be sent to VAST Support for troubleshooting purposes. They can also be downloaded from VMS." }, { "name": "Infrastructure > Supported Drives", "description": "Supported drives are SSD and SCM drives compatible with the running cluster version." }, { "name": "Infrastructure > Switches", "description": "Switches represent switches in the cluster." }, { "name": "Element Store > S3 Lifecycle Rules", "description": "An S3 Lifecycle configuration is a set of rules that define actions that an S3 service applies to a group of objects. VAST Cluster supports S3 Lifecycle configurations that define expiration actions. These actions define when objects expire." }, { "name": "User Management > Identity Policies", "description": "Identity policies comprise statements that grant or deny permissions for any combination of specific actions on any combination of specified resources. They are the primary access control method available with the VAST Cluster S3 service. Identity policies are manageable exclusively through VMS. They are written in JSON document structure. Multiple identity policies can be attached to multiple users and to multiple groups. Permissions denied by identity policies override permissions allowed by identity policies. Permissions allowed or denied by identity policies override S3 ACLs." }, { "name": "Database > Tables", "description": "With VAST Database you can store, access and manage tabular data on a VAST cluster. The tables endpoint enables you to interface with the VAST Database tables. You can create tables, filter data, perform modifications and run ACID transactions." }, { "name": "Element Store > Tenants", "description": "Tenants are divisions of the cluster's storage resources, with isolated data paths, serving different client IPs. There is one default tenant, which cannot be deleted. Each tenant has its own VMS domain that can be managed by tenant admin users." }, { "name": "Authentication > Token", "description": "Tokens are JSON Web Tokens (JWTs), which can be used instead of Apitokens to authenticate requests to the VMS REST API." }, { "name": "Analytics > Top Performer Analytics", "description": "Top performer analytics are performance metrics of the n most active client users, views, client hosts, vips, vip pools and cnodes." }, { "name": "Alarms and Events > Topics", "description": "Topics store categories of events collected by VAST Event Broker." }, { "name": "Element Store > User Quotas", "description": "A userquota object defines a user or group quota. A user or group quota limits the capacity and number of files or directories that a specified user or group can own within a directory. A userquota object doesn't specify any directory. A userquota object is effective when specified in a quota object." }, { "name": "User Management > Users", "description": "Users who can be authorized to access any data on the cluster via any supported client protocol can be created on a VAST provider. They are more typically stored on external authorization providers (AD, LDAP and NIS). The users path provides: management of VAST provider users, querying of external provider users, and S3 access management for both local and external users." }, { "name": "Database > VAST DB", "description": "This endpoint enables you to get virtual IPs for accessing the VAST DataBase." }, { "name": "Database > VAST Audit Log", "description": "The VAST audit log is a database that can store VAST cluster protocol audits. If protocol auditing is enabled and configured to be logged to VAST audit log, the endpoint can be used to query the VAST audit log." }, { "name": "Support > Versions", "description": "The cluster platform and VMS software is installed and upgraded via packages that have a version number per release and a software build number. The versions path exposes the cluster's version history." }, { "name": "Element Store > Views", "description": "A view exposes a path in the VAST Cluster Element Store* to one or more access protocols. Client access via any protocol is enabled only through views. Each view can be enabled for access via one or more of the following protocols, subject to restrictions on combinations: NFSv3, NFSv4.1 and NFSv4.2, SMBv2, S3, VAST Database, Kafka (event publishing) and block storage. *The Element Store is VAST's multiprotocol data namespace. The Element Store can simultaneously present data as objects in a flat hierarchy and as files in a hierarchy of directories." }, { "name": "Element Store > View Policies", "description": "A view policy specifies view configuration parameters. A view policy can be used by multiple views. Every view is attached to one view policy." }, { "name": "Network Access and Security > VIP Pools", "description": "A VIP pool is a pool of virtual IP operations (VIPs). VAST Cluster listens on VIPs for requests from data traffic. Each VIP pool is dedicated to one of two roles: PROTOCOLS or REPLICATION. Protocols VIP pools are used for client traffic from all of the supported access protocols (NFSv3, NFSv4.2, SMBv2, S3). Replication VIP Pools are used for connectivity with an async replication peer cluster." }, { "name": "Network Access and Security > VIPs", "description": "A VIP is a virtual IP address that belongs to a VIP pool." }, { "name": "Infrastructure > Virtual Machines", "description": "Virtual machines can include EBox hosts and virtual machine hosts that comprise VAST on Cloud (VoC) clusters. Each virtual machine runs CNodes and DNodes in containers. Both EBoxes and GCP VoC virtual machines each run one CNode container and two DNode containers." }, { "name": "VMS Management > VMS", "description": "The VMS path represents VMS settings, such as the management VIP used to access the VMS interfaces, login banner text for the VMS CLI and Web UI, access token lifetimes for the REST API and more." }, { "name": "Element Store > Volumes", "description": "Volumes are block storage volumes, which can be provisioned on the cluster. Volumes of block storage are provisioned on block subsystems. Block subsystems are implemented as views. Before creating a volume, create a view and enable the block protocol on the view." }, { "name": "Alarms and Events > Webhooks", "description": "Webhooks send event information to external applications. Once defined, you can set them to be triggered by specific events." }, { "name": "Data Engine > Compute Clusters", "description": "VAST compute clusters are container orchestration clusters that you can deploy on the VAST cluster's own hardware infrastructure and use to handle container orchestration for VAST DataEngine. DataEngine can be deployed with one or more VAST compute clusters or with external Kubernetes clusters or with both." }, { "name": "Administrators > S3 Keys" }, { "name": "Element Store > Open Files Queries" }, { "name": "Network Access and Security > TLS Certificates" } ], "paths": { "/clusters/{id}/locks/": { "delete": { "tags": [ "Element Store > Locks", "Infrastructure > Clusters" ], "summary": "Deletes NLM Locks", "description": "This endpoint deletes NLM locks on a file.", "operationId": "cluster_locks_delete", "parameters": [ { "$ref": "#/components/parameters/ClusterId" } ], "requestBody": { "$ref": "#/components/requestBodies/ClusterLocksParamsBody" }, "responses": { "204": { "description": "Deleted", "content": { "application/octet-stream": {} } } } } } }, "components": { "parameters": { "ClusterId": { "name": "id", "in": "path", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "integer" } } }, "requestBodies": { "ClusterLocksParamsBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterLocksParams" } } }, "x-bodyName": "ClusterLocksParamsBody" } }, "securitySchemes": { "basicAuth": { "type": "http", "description": "Basic authentication using VMS user name and password", "scheme": "basic" }, "ApiToken": { "type": "apiKey", "description": "Send current valid API token in an Authorization header with format Api-Token .", "name": "ApiToken", "in": "header" } }, "schemas": { "ClusterLocksParams": { "allOf": [ { "$ref": "#/components/schemas/TenantIdBody" }, { "type": "object", "properties": { "path": { "type": "string", "description": "The full path to a locked file, formed as: VIEW_PATH/FILE_PATH, where VIEW_PATH is the VAST Cluster view path, and FILE_PATH is the client path to a locked file, relative to the mount point." }, "unlock_type": { "enum": [ "SINGLE", "ALL" ], "type": "string", "description": "The type of unlock operation to perform. 'SINGLE' unlocks a single specified lock, 'ALL' unlocks all locks." }, "unlock_id": { "type": "string", "description": "Unlock ID. Specify if unlock_type is SINGLE." }, "lock_type": { "enum": [ "LOCK_TYPE_NLM4", "LOCK_TYPE_NFS4", "LOCK_TYPE_SMB2" ], "type": "string", "description": "Lock type. Specify if unlock_type is SINGLE." } } } ] }, "TenantIdBody": { "minimum": 1, "type": "object", "properties": { "tenant_id": { "type": "integer" } } } } } } ````