Gitpod API Reference | Secrets

API Reference

Secrets

secrets

Methods

Create Secret -> { secret }

post/gitpod.v1.SecretService/CreateSecret

Creates a new secret for a project.

Use this method to:

Store sensitive configuration values
Set up environment variables
Configure registry authentication
Add file-based secrets

Examples

Create environment variable:

Creates a secret that will be available as an environment variable.

name: "DATABASE_URL"
projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
value: "postgresql://user:pass@localhost:5432/db"
environmentVariable: true

Create file secret:

Creates a secret that will be mounted as a file.

name: "SSH_KEY"
projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
value: "-----BEGIN RSA PRIVATE KEY-----\n..."
filePath: "/home/gitpod/.ssh/id_rsa"

Create registry auth:

Creates credentials for private container registry.

name: "DOCKER_AUTH"
projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
value: "username:password"
containerRegistryBasicAuthHost: "https://registry.example.com"

Delete Secret -> unknown

post/gitpod.v1.SecretService/DeleteSecret

Deletes a secret permanently.

Use this method to:

Remove unused secrets
Clean up old credentials

Examples

Delete secret:

Permanently removes a secret.

secretId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"

Get Secret Value -> { value }

post/gitpod.v1.SecretService/GetSecretValue

Gets the value of a secret. Only available to environments that are authorized to access the secret.

Use this method to:

Retrieve secret values
Access credentials

Examples

Get secret value:

Retrieves the value of a specific secret.
```
secretId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```

List Secrets -> SecretsPage<

Secret

post/gitpod.v1.SecretService/ListSecrets

Lists secrets with optional filtering.

Use this method to:

View all project secrets
Filter secrets by project

Examples

List project secrets:

Shows all secrets for a project.

filter:
  projectIds: ["b0e12f6c-4c67-429d-a4a6-d9838b5da047"]
pagination:
  pageSize: 20

query Parameters

token: string

Optional

pageSize: number

Optional

(maximum: 100, minimum: 0, default: 25)

Response fields

pagination: { nextToken }

Optional

pagination contains the pagination options for listing secrets

secrets: Array<

Secret

Optional

Request example

curl https://app.gitpod.io/api/gitpod.v1.SecretService/ListSecrets \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

200Example

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "secrets": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "containerRegistryBasicAuthHost": "https://example.com",
      "createdAt": "2019-12-27T18:11:19.117Z",
      "creator": {
        "id": "id",
        "principal": "PRINCIPAL_UNSPECIFIED"
      },
      "environmentVariable": true,
      "filePath": "filePath",
      "name": "name",
      "projectId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updatedAt": "2019-12-27T18:11:19.117Z"
    }
  ]
}

Update Secret Value -> unknown

post/gitpod.v1.SecretService/UpdateSecretValue

Updates the value of an existing secret.

Use this method to:

Rotate secret values
Update credentials

Examples

Update secret value:

Changes the value of an existing secret.

secretId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
value: "new-secret-value"

Domain types

Secret = { id, containerRegistryBasicAuthHost, createdAt, 6 more... }