Files
animethemes-api-docs/docs/admin/dump/index.md
T
paranarimasu fa3c714de4 feat: add documentation for restore endpoints (#52)
* feat: add documentation for restore endpoints

* fix: missing prefix on playlist restore route
2024-03-21 22:28:39 +01:00

1.8 KiB

title
title
Dump

Dump


A dump API resource represents a database dump of selected tables at a given point in time.

For example, the animethemes-db-dump-wiki-1663559663946.sql dump represents the database dump of wiki tables performed at 2022-09-19.

Fields

Name Type Nullable Description
id Integer No The primary key of the resource
path String No The path of the file in storage
created_at Date No The date that the resource was created
updated_at Date No The date that the resource was last modified
deleted_at Date Yes The date that the resource was deleted
link String No The URL to download the file from storage

Allowed Include Paths

None

Endpoints

Dump Destroy

The dump destroy endpoint soft deletes a dump and returns the deleted dump resource.

Dump Force Delete

The dump force delete endpoint hard deletes a dump and returns a confirmation message.

Dump Index

The dump index endpoint displays a listing of dump resources.

Dump Restore

The dump restore endpoint restores a soft deleted dump and returns the restored dump resource.

Dump Show

The dump show endpoint returns a dump resource.

Dump Store

The dump store endpoint creates a new dump and returns the new dump resource.

Dump Update

The dump update endpoint updates a dump and returns the updated dump resource.