List database snapshots

Get a list of all snapshots for a specific database cluster.

GET /databases/clusters/{database}/snapshots

List database snapshots

cURL

curl --request GET \
  --url https://cloud.laravel.com/api/databases/clusters/{database}/snapshots \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "type": "database_snapshots",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "name": "<string>",
        "description": "<string>",
        "type": "manual",
        "status": "pending",
        "storage_bytes": 123,
        "pitr_enabled": true,
        "pitr_ends_at": "2023-11-07T05:31:56Z",
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "database": {
          "data": {
            "type": "databases",
            "id": "<string>"
          }
        }
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  },
  "included": [
    {
      "id": "<string>",
      "type": "databases",
      "attributes": {
        "name": "<string>",
        "type": "laravel_mysql_84",
        "status": "creating",
        "region": "us-east-2",
        "created_at": "2023-11-07T05:31:56Z",
        "config": {
          "cu_min": 0.25,
          "cu_max": 0.25,
          "suspend_seconds": 123,
          "retention_days": 123
        },
        "connection": {
          "hostname": "<string>",
          "port": 3306,
          "protocol": "mysql",
          "driver": "mysql",
          "username": "<string>",
          "password": "<string>"
        }
      },
      "relationships": {
        "schemas": {
          "data": [
            {
              "type": "databaseSchemas",
              "id": "<string>"
            }
          ]
        },
        "databases": {
          "data": [
            {
              "type": "databaseSchemas",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The Bearer Token generated on the Cloud UI.

Path Parameters

database · string | null · required

The database identifier

Query Parameters

include · string

Available includes are database. You can include multiple options by separating them with a comma.

Response

200

application/vnd.api+json

Paginated set of DatabaseSnapshotResource

data · DatabaseSnapshotResource · object[] · required

Show child attributes

links · object · required

Show child attributes

meta · object · required

Show child attributes

included · DatabaseResource · object[]

Show child attributes