v18

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

Signup

Establishes initial connection between a runner and the Gitpod backend. This is the first call a runner makes to register itself and establish its identity.

Use this method to:

  • Register new runners with the platform
  • Exchange cryptographic keys for secure communication
  • Declare supported environment classes and capabilities
  • Initialize runner configuration

Examples

  • Register runner:

    Registers a new runner with its public key and supported environment classes.

    publicKey: "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"  # 32 bytes of zeros, base64 encoded
    environmentClasses:
      - id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
        runnerId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
        displayName: "Large Instance"
        description: "8 CPU, 16GB RAM"
        enabled: true
        configuration:
          - key: "cpu"
            value: "8"
          - key: "memory"
            value: "16384"
    
post/gitpod.v1.RunnerInteractionService/Signup

Request body

publicKeystring byte

The runner's public key. Must be an ECDH public key encoded in PKIX, ASN.1 DER format.

Response

Success

runnerIdstring uuid

The runner's identity