v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.EnvironmentService

AllowPortAccess

Deprecated: Use local validation with the environment state cache instead.

Checks if the authenticated caller can access a specific port on an environment. This is called by the Runner Proxy to validate access tokens against current state. The caller's identity is extracted from the JWT in the request context.

Examples

  • Check port access:

    Verifies if the caller can access port 8080 on an environment.

    environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
    port: 8080
    
post/gitpod.v1.EnvironmentService/AllowPortAccess

Request body

environmentIdstring uuid

environment_id specifies the environment to check access for.

+required

portinteger

port specifies the port number to check access for.

+required

Response

Success

allowedboolean

allowed indicates whether the caller is permitted to access the port.