Get server monitoring overview

Returns time-series server monitoring data for the specified metrics (wall time, memory usage, peak memory usage, CPU load, stdout, requests per minute). Includes alert evaluations and APM quota usage. Data points contain metric values aggregated at the requested granularity.

GET /projects/{projectId}/environments/{environmentId}/observability/server

Get server monitoring overview

cURL

curl --request GET \
  --url {schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/observability/server \
  --header 'Authorization: Bearer <token>'

200

{
  "_quota": {
    "allowed": 2147000000,
    "used": 103139,
    "exceeded": false,
    "period_started_at": "2026-02-01T00:00:00+00:00",
    "period_ends_at": "2026-03-01T00:00:00+00:00"
  },
  "_grain": 10,
  "_from": 1771435023,
  "_to": 1771440423,
  "_keys": [
    "wt",
    "rpms"
  ],
  "_agent": "a38f69ca-3b56-4ea6-beac-272b2568164a",
  "_contexts": [
    "web"
  ],
  "_contexts_mode": "additive",
  "_project_id": "abc123def456",
  "_environment_id": "main",
  "_branch_machine_name": "main-bvxea6i",
  "alert_evaluations": [
    {
      "timestamp": 1771435030,
      "alert_rule_uuid": "b534721b-9751-49bf-ad86-e3bf50d6ec39",
      "value": 92395.49,
      "state": "normal"
    }
  ],
  "server": {
    "total": 136328,
    "data": [
      {
        "timestamp": 1771435020,
        "rpms": 672,
        "wt": 89698.03
      },
      {
        "timestamp": 1771435030,
        "rpms": 1338,
        "wt": 82021.59
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId · string · required

The unique identifier of the Upsun project

Pattern: [a-z0-9]+

Example:

"abc123def456"

environmentId · string · required

The environment identifier

Pattern: .+

Example:

"main"

Query Parameters

from · integer<int64> · required

Start timestamp for the time range (Unix timestamp in seconds)

Example:

1704067200

to · integer<int64> · required

End timestamp for the time range (Unix timestamp in seconds)

Example:

1704153600

keys[] · enum<string>[] · required

Metrics to retrieve (wall time, memory usage, peak memory, CPU load, stdout, requests per minute)

Available options: wt, mu, pmu, load, stdout, rpms

grain · integer

Granularity of data points in seconds. Auto-calculated if omitted.

Example:

10

contexts[] · enum<string>[]

Filter by execution contexts. Defaults to ["web"] with additive mode when neither contexts nor contexts_mode is specified.

Available options: web, cli

contexts_mode · enum<string>

Filter mode for contexts parameter. "1" (additive, default) includes only specified contexts. "-1" (subtractive) excludes specified contexts and includes all others. When neither contexts nor contexts_mode is specified, defaults to "1" (additive) with contexts=["web"].

Available options: 1, -1

Example:

"1"

applications[] · string[]

Filter by application names

applications_mode · enum<string>

Filter mode for applications parameter. "1" (additive) includes only specified applications. "-1" (subtractive) excludes specified applications and includes all others. When omitted: defaults to "-1" if no applications values are provided; defaults to "1" (additive) if at least one applications value is provided.

Available options: 1, -1

Example:

"1"

instances[] · string[]

Filter by instance names

instances_mode · enum<string>

Filter mode for instances parameter. "1" (additive) includes only specified instances. "-1" (subtractive) excludes specified instances and includes all others. When omitted: defaults to "-1" if no instances values are provided; defaults to "1" (additive) if at least one instances value is provided.

Available options: 1, -1

Example:

"1"

distribution_cost · enum<string>

Cost distribution dimension for server load distribution.

Available options: wt, pmu

Response

200

application/json

Server global metrics retrieved successfully

_quota · object · required

APM quota usage information

Show child attributes

_grain · integer · required

Data granularity in seconds

Example:

5

_from · integer · required

Query start timestamp

Example:

1704067200

_to · integer · required

Query end timestamp

Example:

1704153600

_keys · string[] · required

Requested metric keys

Example:

["wt", "rpms"]

_agent · string<uuid> · required

Blackfire Agent UUID

Example:

"a38f69ca-3b56-4ea6-beac-272b2568164a"

_contexts · string[] | null · required

Applied context filter values

_contexts_mode · enum<string> | null · required

Context filter mode (additive=include only, subtractive=exclude)

Available options: additive, subtractive

_project_id · string · required

Project identifier

Example:

"abc123def456"

_environment_id · string · required

Environment identifier

Example:

"main"

_branch_machine_name · string · required

Branch machine name

Example:

"main-bvxea6i"

alert_evaluations · object[] · required

Alert rule evaluations for the time range

Show child attributes

server · object · required

Server metrics data

Show child attributes

_applications · string[] | null

Applied application filter values

_applications_mode · enum<string> | null

Application filter mode (additive=include only, subtractive=exclude)

Available options: additive, subtractive

_instances · string[] | null

Applied instance filter values

_instances_mode · enum<string> | null

Instance filter mode (additive=include only, subtractive=exclude)

Available options: additive, subtractive

_distribution_cost · enum<string>

Applied distribution cost dimension (wt=wall time, pmu=peak memory usage)

Available options: wt, pmu