Get

/bigcatalogconfig/{id}/

This endpoint returns details of the VAST Catalog configuration.

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

Vastcatalogconfig ID

Responses

200

OK

Expand All

object

id

integer

name

string

title

string

guid

string

unique identifier

url

string

is_on_schedule

boolean

pretty_schedules

Array of string

string

replication_target

string

handle

string

created

string

schedule_miss

integer

native_replication_remote_target

string

is_local

boolean

target_guid

string

target_object_id

integer

target object id

target_name

string

Target Name

frames

Array of object (Frame)

Defines the schedule for snapshot creation and the local and remote retention policies.

Exampleevery 90m start-at 2025-07-27 20:10:35 keep-local 10h keep-remote 30d

object

every

string

Example30m

start-at

string

Example2021-02-03 01:02:03

keep-local

string

Example30m

keep-remote

string

Example30m

prefix

string

The prefix of the snapshot that will be created

clone_type

string

Specify the type of data protection. CLOUD_REPLICATION is S3 backup. LOCAL means local snapshots without replication.

Valid values[ "LOCAL", "NATIVE_REPLICATION", "CLOUD_REPLICATION" ]

state

string

State of Protection Policy

Valid values[ "DELETE_PENDING", "working", "delete_pending" ]

sync_interval

integer

A sync point is a common restore point for all group members. This value guarantees such a sync point exists in this duration. In other words, this is the maximal sync duration gap between other members.

internal

boolean

indestructible

boolean

Protected from accidental or malicious deletion by the indestructibility mechanism. Authorized unlocking of the cluster's indestructibility mechanism is required to do any of the following: deleting the protection policy, modifying the protection policy, or disabling this setting.

tenant_id

integer

tenant

object (PartialTenantInfo)

id

integer

Tenant ID

name

string

Tenant Name

remote_tenant

object (RemoteTenant)

name

string

Remote Tenant name

guid

string

Remote Tenant guid

enable

boolean

Flag indicating the status of vast catalog config

Return VAST Catalog Configuration