Skip to main content
GET
/
projects
/
{projectId}
/
environments
/
{environmentId}
/
observability
Get observability entrypoint
curl --request GET \
  --url {schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/observability \
  --header 'Authorization: Bearer <token>'
{
  "message": "bonjour, monde!",
  "project_id": "abc123def456",
  "branch_machine_name": "main",
  "environment_id": "main",
  "environment_type": "production",
  "vendor": "upsun",
  "psh_user_identifier": "user@example.com",
  "_links": {
    "_self": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability"
    },
    "resources_by_service": {
      "app": {
        "name": "app",
        "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/resources/service/app"
      },
      "database": {
        "name": "database",
        "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/resources/service/database"
      }
    },
    "resources_overview": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/resources/overview"
    },
    "resources_summary": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/resources/summary"
    },
    "blackfire_php_server_caches": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/server/caches"
    },
    "blackfire_server_global": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/server"
    },
    "blackfire_server_transactions_breakdown": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/server/transactions-break-down"
    },
    "logs_query": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/logs/query"
    },
    "logs_overview": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/logs/overview"
    },
    "http_metrics_overview": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/http-metrics/overview"
    },
    "http_metrics_timeline_urls": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/http/breakdown/urls"
    },
    "http_metrics_timeline_ips": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/http/breakdown/ips"
    },
    "http_metrics_timeline_user_agents": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/http/breakdown/user-agents"
    },
    "console_sandbox_access": {
      "href": "https://api.upsun.com/projects/abc123def456/environments/main/observability/console/sandbox-access"
    },
    "conprof_applications": {
      "href": "https://conprof.blackfire.io/projects/abc123def456/env/main/continuous-profiling"
    },
    "conprof_application_filters": {
      "href": "https://conprof.blackfire.io/projects/abc123def456/env/main/continuous-profiling/app/myapp/filter"
    },
    "conprof_timeline": {
      "href": "https://conprof.blackfire.io/projects/abc123def456/env/main/continuous-profiling/app/myapp"
    },
    "conprof_flamegraph": {
      "href": "https://conprof.blackfire.io/projects/abc123def456/env/main/continuous-profiling/app/myapp/merge"
    }
  },
  "retention": {
    "resources": 43200,
    "logs": 43200,
    "http_traffic": 43200,
    "continuous_profiling": 80640
  },
  "data_retention": {
    "_unit": "minute",
    "_unit_in_seconds": 60,
    "resources": {
      "retention_period": 43200,
      "max_range": 43200,
      "recommended_default_range": 43200
    },
    "server_monitoring": {
      "retention_period": 80640,
      "max_range": 20160,
      "recommended_default_range": 1440
    },
    "logs": {
      "retention_period": 43200,
      "max_range": 43200,
      "recommended_default_range": 43200
    },
    "http_traffic": {
      "retention_period": 43200,
      "max_range": 43200,
      "recommended_default_range": 43200
    },
    "continuous_profiling": {
      "retention_period": 43200,
      "max_range": 43200,
      "recommended_default_range": 43200
    }
  }
}

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"

Response

Observability entrypoint retrieved successfully

​
message
string
required

Welcome message

Example:

"bonjour, monde!"

​
project_id
string
required

Project identifier

Example:

"abc123def456"

​
branch_machine_name
string
required

Branch machine name

Example:

"main"

​
environment_id
string
required

Environment identifier

Example:

"main"

​
environment_type
enum<string>
required

Environment type classification

Available options:
production,
staging,
development
Example:

"production"

​
vendor
enum<string>
required

Platform vendor identifier

Available options:
upsun,
platformsh
Example:

"upsun"

​
psh_user_identifier
string
required

Authenticated user identifier

Example:

"user@example.com"

​
_links
object
required

HATEOAS navigation links to all observability endpoints

​
retention
object
required

DEPRECATED: Data retention periods in minutes per resource type. Use data_retention instead.

​
data_retention
object
required

Data retention policies per metric type with periods in minutes

Last modified on March 25, 2026