Skip to main content
GET
/
databases
/
clusters
/
{database}
/
metrics
Get database cluster metrics
curl --request GET \
  --url https://cloud.laravel.com/api/databases/clusters/{database}/metrics \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "cpu_usage": {
      "labels": [
        "<string>"
      ],
      "average": [
        123
      ],
      "data": [
        {
          "x": "<string>",
          "y": [
            123
          ]
        }
      ]
    },
    "compute_hours": {
      "labels": [
        "<string>"
      ],
      "average": [
        123
      ],
      "data": [
        {
          "x": "<string>",
          "y": [
            123
          ]
        }
      ]
    },
    "memory_usage": {
      "labels": [
        "<string>"
      ],
      "average": [
        123
      ],
      "data": [
        {
          "x": "<string>",
          "y": [
            123
          ]
        }
      ]
    },
    "writes": {
      "labels": [
        "<string>"
      ],
      "average": [
        123
      ],
      "data": [
        {
          "x": "<string>",
          "y": [
            123
          ]
        }
      ]
    },
    "storage_usage": {
      "labels": [
        "<string>"
      ],
      "average": [
        123
      ],
      "data": [
        {
          "x": "<string>",
          "y": [
            123
          ]
        }
      ]
    },
    "replica_lag": {
      "labels": [
        "<string>"
      ],
      "average": [
        123
      ],
      "data": [
        {
          "x": "<string>",
          "y": [
            123
          ]
        }
      ]
    }
  },
  "meta": {
    "period": "<string>",
    "available_periods": [
      "<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

period
enum<string>
Available options:
6h,
24h,
3d,
7d,
30d

Response

data
object
required
meta
object
required