{ "opencollection": "1.0.0", "info": { "name": "gitpod.v1 gitpod.v1.AccountService gitpod.v1.SecretService API", "version": "v1.0.0" }, "items": [ { "info": { "name": "gitpod.v1.SecretService", "type": "folder" }, "items": [ { "info": { "name": "CreateSecret", "type": "http" }, "http": { "method": "POST", "url": "https://api.gitpod.io/gitpod.v1.SecretService/CreateSecret", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new secret for a project.\n\n Use this method to:\n - Store sensitive configuration values\n - Set up environment variables\n - Configure registry authentication\n - Add file-based secrets\n\n ### Examples\n\n - Create environment variable:\n\n Creates a secret that will be available as an environment variable.\n\n ```yaml\n name: \"DATABASE_URL\"\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n value: \"postgresql://user:pass@localhost:5432/db\"\n environmentVariable: true\n ```\n\n - Creat" }, { "info": { "name": "DeleteSecret", "type": "http" }, "http": { "method": "POST", "url": "https://api.gitpod.io/gitpod.v1.SecretService/DeleteSecret", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a secret permanently.\n\n Use this method to:\n - Remove unused secrets\n - Clean up old credentials\n\n ### Examples\n\n - Delete secret:\n\n Permanently removes a secret.\n\n ```yaml\n secretId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" }, { "info": { "name": "GetSecretValue", "type": "http" }, "http": { "method": "POST", "url": "https://api.gitpod.io/gitpod.v1.SecretService/GetSecretValue", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets the value of a secret. Only available to environments that are authorized to access the secret.\n\n Use this method to:\n - Retrieve secret values\n - Access credentials\n\n ### Examples\n\n - Get secret value:\n\n Retrieves the value of a specific secret.\n\n ```yaml\n secretId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" }, { "info": { "name": "ListSecrets", "type": "http" }, "http": { "method": "POST", "url": "https://api.gitpod.io/gitpod.v1.SecretService/ListSecrets", "params": [ { "name": "pageSize", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Lists secrets\n\n Use this method to:\n - View all project secrets\n - View all user secrets\n\n ### Examples\n\n - List project secrets:\n\n Shows all secrets for a project.\n\n ```yaml\n filter:\n scope:\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n pagination:\n pageSize: 20\n ```\n\n - List user secrets:\n\n Shows all secrets for a user.\n\n ```yaml\n filter:\n scope:\n userId: \"123e4567-e89b-12d3-a456-426614174000\"\n pagination:\n pageSize: 20\n ```" }, { "info": { "name": "UpdateSecretValue", "type": "http" }, "http": { "method": "POST", "url": "https://api.gitpod.io/gitpod.v1.SecretService/UpdateSecretValue", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the value of an existing secret.\n\n Use this method to:\n - Rotate secret values\n - Update credentials\n\n ### Examples\n\n - Update secret value:\n\n Changes the value of an existing secret.\n\n ```yaml\n secretId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n value: \"new-secret-value\"\n ```" } ] } ], "bundled": true }