mirror of
https://github.com/Skyvern-AI/skyvern.git
synced 2026-04-28 19:50:42 +00:00
73 lines
2.1 KiB
Text
73 lines
2.1 KiB
Text
---
|
|
title: "get_credentials"
|
|
slug: sdk-reference/credentials/get-credentials
|
|
---
|
|
|
|
List all credentials. Credential values are never returned - only metadata.
|
|
|
|
<CodeGroup>
|
|
```python Python
|
|
creds = await client.get_credentials()
|
|
for c in creds:
|
|
print(f"{c.name} ({c.credential_id})")
|
|
```
|
|
|
|
```typescript TypeScript
|
|
const creds = await skyvern.getCredentials({});
|
|
for (const c of creds) {
|
|
console.log(`${c.name} (${c.credential_id})`);
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| `page` | `int` | No | `None` | Page number. |
|
|
| `page_size` | `int` | No | `None` | Results per page. |
|
|
| `vault_type` | `CredentialVaultType` | No | `None` | Filter credentials by vault type (e.g. `"custom"`, `"bitwarden"`, `"azure_vault"`). |
|
|
| `request_options` | `RequestOptions` | No | `None` | Per-request configuration (see below). |
|
|
|
|
### Returns `list[CredentialResponse]`
|
|
|
|
---
|
|
|
|
### Request options
|
|
|
|
|
|
Override timeout, retries, or headers for this call by passing `request_options` (Python) or a second options argument (TypeScript).
|
|
|
|
<CodeGroup>
|
|
```python Python
|
|
from skyvern.client.core import RequestOptions
|
|
|
|
request_options=RequestOptions(
|
|
timeout_in_seconds=120,
|
|
max_retries=3,
|
|
additional_headers={"x-custom-header": "value"},
|
|
)
|
|
```
|
|
|
|
```typescript TypeScript
|
|
// Pass as second argument to any method
|
|
{
|
|
timeoutInSeconds: 120,
|
|
maxRetries: 3,
|
|
headers: { "x-custom-header": "value" },
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
|
|
| Option (Python) | Option (TypeScript) | Type | Description |
|
|
|-----------------|---------------------|------|-------------|
|
|
| `timeout_in_seconds` | `timeoutInSeconds` | `int` / `number` | HTTP timeout in seconds. |
|
|
| `max_retries` | `maxRetries` | `int` / `number` | Retry count. |
|
|
| `additional_headers` | `headers` | `dict` / `Record<string, string>` | Extra headers. |
|
|
| `additional_query_parameters` | - | `dict` | Extra query parameters. |
|
|
| `additional_body_parameters` | - | `dict` | Extra body parameters. |
|
|
| - | `abortSignal` | `AbortSignal` | Signal to cancel the request. |
|
|
| - | `apiKey` | `string` | Override API key. |
|
|
|
|
|
|
---
|