How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
VAST Data

VAST Data protectedpaths API

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

VAST Data protectedpaths API is one of 126 APIs that VAST Data publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include protectedpaths. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and SDKs.

This API exposes 20 operations across 15 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against the base URL https://{vms-host}/api.

20 operations 15 paths 8 schemas 2 DELETE4 GET11 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://{vms-host}/api
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

VAST Data protectedpaths API declares 2 security schemes for authenticating requests. An API key is passed in the header as ApiToken (ApiToken). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • ApiToken — Send current valid API token in an Authorization header with format Api-Token .
  • basicAuth — Basic authentication using VMS user name and password

Paths & Operations 20

Across 15 paths, the API surfaces 20 operations — 2 DELETE, 4 GET, 11 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

protectedpaths 20

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 replicati…

GET
/protectedpaths/
List Protected Paths
protectedpaths_list 8 params → 200
POST
/protectedpaths/
Create a Protected Path
protectedpaths_create body → 201
DELETE
/protectedpaths/{id}/
Delete a Protected Path
protectedpaths_delete 1 param → 200204
GET
/protectedpaths/{id}/
Return Details of a Protected Path
protectedpaths_read 1 param → 200
PATCH
/protectedpaths/{id}/
Modify a Protected Path
protectedpaths_partial_update 1 param body → 200
PATCH
/protectedpaths/{id}/add_stream/
Add a Replication Stream to a Protected Path
protectedpaths_add_stream 1 param body → 200
PATCH
/protectedpaths/{id}/commit
Commit a Restored Protected Path
protectedpaths_commit 1 param body → 200
PATCH
/protectedpaths/{id}/force_failover
Force failover on a protected path
protectedpaths_force_failover 1 param → 200
PATCH
/protectedpaths/{id}/modify_member/
Modify Capability of a Replication Stream that Belongs to a Protected Path
protectedpaths_modify_member 1 param body → 200
PATCH
/protectedpaths/{id}/pause
Pause Restore on a Protected Path
protectedpaths_pause 1 param body → 200
DELETE
/protectedpaths/{id}/prefetch_path
Delete Path Prefetch Task
protectedpaths_prefetch_folder_delete 1 param body → 204
GET
/protectedpaths/{id}/prefetch_path
Return Status for Prefetch Path
protectedpaths_get_prefetch_folder_status 2 params → 200
POST
/protectedpaths/{id}/prefetch_path
Prefetch a Path to Global Access Cache
protectedpaths_prefetch_folder_to_cache 2 params body → 200409
PATCH
/protectedpaths/{id}/reattach_stream/
Reattach a Stream to a Protected Path
protectedpaths_reattach_stream 1 param body → 200
PATCH
/protectedpaths/{id}/remove_stream/
Remove a Stream from a Protected Path
protectedpaths_remove_stream 1 param body → 204
PATCH
/protectedpaths/{id}/replicate_now/
Trigger Replication on all the Streams of a Protected Path
protectedpaths_replicate_now 1 param body → 200
POST
/protectedpaths/{id}/restore
Create a Clone to Restore a Path.
protectedpaths_restore 1 param body → 200
PATCH
/protectedpaths/{id}/resume
Resume Restore on a Protected Path
protectedpaths_resume 1 param body → 200
PATCH
/protectedpaths/{id}/stop
Stops snapshot restore on protected path.
protectedpaths_stop 1 param → 200
GET
/protectedpaths/{id}/validate
Returns validations results for Protected Path.
protectedpaths_validate 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ProtectedPath (53 properties), GlobalSnapStream (26 properties), PrefetchFolderStatusResponse (6 properties), ReplicationMemberInfo (3 properties). Each schema is shown below with its type and property counts.

AsyncGlobalSnapStream
ConflictResponse
object
2 properties
PrefetchFolderResponse
object
2 properties
GlobalSnapStream
object
26 properties
PrefetchFolderStatusResponse
object
6 properties
ProtectedPath
object
53 properties 2 required
ReplicationMemberInfo
object
3 properties
AsyncTaskInResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vastdata-protectedpaths-api-openapi.yml Raw ↑

Other APIs VAST Data publishes across the network.

VAST Data activedirectory API
AE Profile APIs.io
VAST Data alarms API
AE Profile APIs.io
VAST Data apitokens API
AE Profile APIs.io
VAST Data basicsettings API
AE Profile APIs.io
VAST Data bgpconfigs API
AE Profile APIs.io
VAST Data Blob Expansions API
AE Profile APIs.io
VAST Data Block Hosts API
AE Profile APIs.io
VAST Data blockhosts API
AE Profile APIs.io
VAST Data blockmappings API
AE Profile APIs.io
VAST Data callhomeconfigs API
AE Profile APIs.io
VAST Data capacity API
AE Profile APIs.io
VAST Data carriers API
AE Profile APIs.io
#protectedpaths
← Back to V APIs
API Details
ID
vastdata:vastdata-protectedpaths-api
Base URL
https://{vms-host}/api
Docs
https://www.vastdata.com/platform/developers
Provider
VAST Data
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vastdata-protectedpaths-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vastdata-protectedpaths-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of VAST Data protectedpaths API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.