Gitpod Documentation | Secrets

API Reference

Secrets

secrets

Methods

Create Secret -> { secret }

post/gitpod.v1.SecretService/CreateSecret

CreateSecret creates a new secret.

Delete Secret -> unknown

post/gitpod.v1.SecretService/DeleteSecret

DeleteSecret deletes a secret.

Get Secret Value -> { value }

post/gitpod.v1.SecretService/GetSecretValue

GetSecretValue retrieves the value of a secret Only Environments can perform this operation, and only for secrets specified on the EnvironmentSpec.

List Secrets -> SecretsPage<{ environmentVariable, id, createdAt, 4 more... } | { filePath, id, createdAt, 4 more... }>

post/gitpod.v1.SecretService/ListSecrets

ListSecrets lists secrets.

Security

Bearer Auth

Example: Authorization: Bearer My Bearer Token

Parameters

token: string

Optional

pageSize: number

Optional

(maximum: 100, minimum: 0)

Response fields

pagination: { nextToken }

Optional

pagination contains the pagination options for listing secrets

secrets: Array<{ environmentVariable, id, createdAt, 4 more... } | { filePath, id, createdAt, 4 more... }>

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": [
    {
      "environmentVariable": true,
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "createdAt": "2019-12-27T18:11:19.117Z",
      "creator": {
        "id": "id",
        "principal": "PRINCIPAL_UNSPECIFIED"
      },
      "name": "name",
      "projectId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updatedAt": "2019-12-27T18:11:19.117Z"
    }
  ]
}

Update Secret Value -> unknown

post/gitpod.v1.SecretService/UpdateSecretValue

UpdateSecretValue updates the value of a secret.