Get list of backups

GET/v1/databases/{databaseId}/backupsGet list of backups

Returns backups for the specified database.

Parameters

databaseIdstringpathrequired

pattern ^(db_)?([cC][^\s-]{8,}|[a-z0-9]+)$

limitintegerquery

default 25 · maximum 100 · minimum 1

Responses

object

dataarray of objectrequired

Show child attributes

Show array items

backupTypestringrequired

one of "full", "incremental", "differential"

createdAtstringrequired

idstringrequired

sizenumber

statusstringrequired

one of "running", "completed", "failed", "unknown"

typestring

const "backup"

metaobjectrequired

Show child attributes

backupRetentionDaysnumberrequired

paginationobjectrequired

Show child attributes

hasMorebooleanrequired

limitvaluerequired

Show child attributes

anyOf · 2 options

Option 1integer

maximum 100 · minimum 1

Option 2nullnullable

Example response

{
  "data": [
    {
      "backupType": "differential",
      "createdAt": "string",
      "id": "string",
      "size": 0,
      "status": "completed",
      "type": "backup"
    }
  ],
  "meta": {
    "backupRetentionDays": 0
  },
  "pagination": {
    "hasMore": true,
    "limit": 0
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Examples

databaseIdrequiredpath parameter

limitquery parameter

curl -X GET 'https://api.prisma.io/v1/databases/string/backups?limit=25'

const response = await fetch('https://api.prisma.io/v1/databases/string/backups?limit=25', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/databases/string/backups?limit=25', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.prisma.io/v1/databases/string/backups?limit=25")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.prisma.io/v1/databases/string/backups?limit=25", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.prisma.io/v1/databases/string/backups?limit=25");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/databases/string/backups?limit=25"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/databases/string/backups?limit=25")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.prisma.io/v1/databases/string/backups?limit=25");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "backupType": "differential",
      "createdAt": "string",
      "id": "string",
      "size": 0,
      "status": "completed",
      "type": "backup"
    }
  ],
  "meta": {
    "backupRetentionDays": 0
  },
  "pagination": {
    "hasMore": true,
    "limit": 0
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Search documentation

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets

Parameters

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets