Laravel

Laravel Backups API

The Backups API from Laravel — 5 operation(s) for backups.

GitHub OpenAPI
Business capability
Disaster Recovery & Resilience BC-4220.60

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /orgs/{organization}/servers/{server}/database/backups List database backup configurations on a server · List backup configurations #
Ask an LLM
“Which backup schedules are set up for my server's databases?”
“Can I filter a server's backup configurations by name or status?”
Tell an agent
List the backup configurations on server {server} in {organization}.
Find backup configurations named {name} on server {server}, {organization}.
POST /orgs/{organization}/servers/{server}/database/backups Schedule database backups on a server · Create backup configuration #
Ask an LLM
“How do I schedule nightly database backups to my storage provider?”
“Can a backup schedule use a custom cron expression and keep only a set number of backups?”
Tell an agent
Back up databases {database_ids} on server {server} ({organization}) to storage {storage_provider_id} {frequency}, keeping {retention}.
Set up backups on server {server} ({organization}) of {dbs} via cron {cron}, keep {retention}, to {storage}, frequency {frequency}.
GET /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration} Get a database backup configuration · Get backup configuration #
Ask an LLM
“What schedule and retention does a particular backup configuration use?”
“Can I see which databases one backup configuration covers?”
Tell an agent
Show backup configuration {backupConfiguration} on server {server} in {organization}.
Get the settings of backup config {backupConfiguration} for server {server}, org {organization}.
PUT /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration} Change a database backup schedule · Update backup configuration #
Ask an LLM
“Can I change how often an existing backup configuration runs?”
“How do I add a notification email to a backup schedule I already set up?”
Tell an agent
Change backup config {config} on server {server} ({organization}) to run {frequency}, keep {retention}, store on {storage}, cover {dbs}.
Update existing backup config {backupConfiguration} on server {server} in {organization}.
DELETE /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration} Delete a database backup configuration · Delete backup configuration #
Ask an LLM
“How do I stop a scheduled database backup permanently?”
“Can I remove a backup configuration I no longer need?”
Tell an agent destructive · confirm first
Delete backup configuration {backupConfiguration} from server {server} in {organization}.
Remove the backup schedule {backupConfiguration} on server {server}, org {organization}.
GET /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances List backups taken by a backup configuration · List backups #
Ask an LLM
“Which database backups have actually been taken under a schedule?”
“Can I filter backup runs by status to find failed ones?”
Tell an agent
List the backups taken by configuration {backupConfiguration} on server {server} in {organization}.
Show backups with status {status} for config {backupConfiguration}, server {server}, {organization}.
POST /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances Run a database backup now · Create backup #
Ask an LLM
“Can I take a database backup right now instead of waiting for the schedule?”
“How do I trigger a manual backup before a risky migration?”
Tell an agent
Run backup configuration {backupConfiguration} now on server {server} in {organization}.
Take a manual backup using config {backupConfiguration} for server {server}, org {organization}.
GET /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances/{backup} Get one database backup · Get backup #
Ask an LLM
“Did a specific backup run succeed?”
“Can I look up one backup taken under a configuration?”
Tell an agent
Check whether backup run {backup} succeeded under schedule {config} on server {server}, {organization}.
Get the details of backup {backup} (config {backupConfiguration}, server {server}, {organization}).
DELETE /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances/{backup} Delete one database backup · Delete backup #
Ask an LLM
“Can I delete a single old backup without touching the schedule?”
“What removes one backup file taken by a configuration?”
Tell an agent destructive · confirm first
Delete the single backup file {backup} produced by schedule {config} on server {server}, {organization}.
Remove the backup {backup} taken by config {backupConfiguration}, server {server}, org {organization}.
POST /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances/{backup}/restores Restore a database from a backup · Create a database restore from backup #
Ask an LLM
“How do I restore a database from last night's backup?”
“Can I choose which database a backup gets restored into?”
Tell an agent destructive · confirm first
Restore database {database_id} from backup {backup} (config {backupConfiguration}) on server {server} in {organization}.
Roll database {database_id} back to backup {backup} of config {backupConfiguration}, server {server}, org {organization}.

Documentation

📖
Documentation
https://forge.laravel.com/docs/api-reference/introduction
📖
APIReference
https://forge.laravel.com/docs/api-reference/introduction
📖
Documentation
https://cloud.laravel.com/docs/api/authentication
📖
APIReference
https://cloud.laravel.com/docs/api/authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/laravel/openapi/laravel-backups-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/laravel:laravel-backups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

laravel-backups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Forge Backups API
  version: 0.0.1
  description: Laravel Forge - API Documentation
servers:
- url: https://forge.laravel.com/api
security:
- http: []
- oauth2: []
tags:


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/laravel/openapi/laravel-backups-api-openapi.yml