Class ArchiveResource

Net archive CRUD and sync status.

Index

Constructors

Methods

delete get list restore syncStatus update upsert

Constructors

constructor

new ArchiveResource(http: BaseClient): ArchiveResource
Parameters
- http: BaseClient
Returns ArchiveResource
- Defined in src/resources/archive.ts:19

Methods

delete

delete(uid: string): Promise<ShardArchiveDeleteResponse>
Soft-deletes an archive entry.
Parameters
- uid: string
  Archive entry unique identifier.
Returns Promise<ShardArchiveDeleteResponse>
- Defined in src/resources/archive.ts:69

get

get(uid: string): Promise<ShardArchiveEntryResponse>
Fetches a single archive entry by UID.
Parameters
- uid: string
  Archive entry unique identifier.
Returns Promise<ShardArchiveEntryResponse>
- Defined in src/resources/archive.ts:43

list

list(query?: ArchiveListQuery): Promise<ShardArchiveListResponse>
Lists archived net configurations.
Parameters
- Optionalquery: ArchiveListQuery
  Optional filters for tag, search text, and result limit.
Returns Promise<ShardArchiveListResponse>
- Defined in src/resources/archive.ts:27

restore

restore(uid: string): Promise<ShardArchiveRestoreResponse>
Restores a previously deleted archive entry.
Parameters
- uid: string
  Archive entry unique identifier.
Returns Promise<ShardArchiveRestoreResponse>
- Defined in src/resources/archive.ts:79

syncStatus

syncStatus(): Promise<ShardArchiveSyncStatusResponse>
Fetches the archive sync/checkpoint status.

Returns Promise<ShardArchiveSyncStatusResponse>
- Defined in src/resources/archive.ts:87

update

update(
uid: string,
payload: ArchiveUpsertPayload,
): Promise<ShardArchiveUpsertResponse>
Updates an existing archive entry by UID.
Parameters
- uid: string
  Archive entry unique identifier.
- payload: ArchiveUpsertPayload
Returns Promise<ShardArchiveUpsertResponse>
- Defined in src/resources/archive.ts:58

upsert

upsert(payload: ArchiveUpsertPayload): Promise<ShardArchiveUpsertResponse>
Creates or updates an archive entry.
Parameters
- payload: ArchiveUpsertPayload
Returns Promise<ShardArchiveUpsertResponse>
- Defined in src/resources/archive.ts:50