---
title: "Credentials Vault APIs"
slug: "credentials-vault-apis"
description: "Learn how to use Kentik's Credentials Vault APIs to programmatically manage secure secrets, credential groups, and authentication for your network."
updated: 2026-02-20T15:34:28Z
published: 2026-02-20T15:34:28Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://kb.kentik.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Credentials Vault APIs

> [!NOTE]
> **Note**: This alpha API is neither supported nor recommended for production use. For additional information, please contact [**Product Support**](/v1/docs/customer-care).

This article covers how to get started with the Credentials Vault APIs.

> [!NOTE]
> **Notes:**
> 
> - The [**API Tester**](https://portal.kentik.com/v4/core/api-tester) in the v4 Portal enables you to securely call the methods of these APIs using your organization's Kentik data.
> - For an explanation of the capabilities and usage of the Credentials Vault in the Kentik portal, see [**Credentials Vault**](/v1/docs/credentials-vault).
> - Protobuf and OpenAPI specifications for Kentik’s v6 APIs are available in our [**api-schema-public**](https://github.com/kentik/api-schema-public) repository.

## Credentials Vault Usage

The Credentials Vault API enables programmatic access to credential information in Kentik Credential Vault.

## Credentials Vault RPCs

The tables below provide a quick reference to key information about each Remote Procedure Call in these APIs. Use the links in the tables to see schemas for the request and/or response body (if any).

> [!NOTE]
> **Note:** To test methods using your own Kentik data, use the portal's [**API Tester**](https://portal.kentik.com/v4/core/api-tester).

### ListCredentialGroup

**API: CredentialService**

| REST Method | REST Endpoint | Description |
| --- | --- | --- |
| GET | /credential/v202407alpha1 /group | Returns list of credential group information in Kentik vault. |
| \| **Request body**: None **Parameters**: None \| **Response body**: [v202407alpha1ListCredentialGroupResponse](/v1/docs/credentials-vault-apis#listcredentialgroupresponse) \| \| --- \| --- \| |
| **Request body**: None **Parameters**: None | **Response body**: [v202407alpha1ListCredentialGroupResponse](/v1/docs/credentials-vault-apis#listcredentialgroupresponse) |

### GetCredentialGroup

**API: CredentialService**

| REST Method | REST Endpoint | Description |
| --- | --- | --- |
| GET | /credential/v202407alpha1 /group/{id} | Returns specific credential group information in Kentik vault. |
| \| **Request body**: None \| **Response body**: [v202407alpha1GetCredentialGroupResponse](/v1/docs/credentials-vault-apis#getcredentialgroupresponse) \| \| --- \| --- \| **Parameters:** \| Name \| Description \| Required \| Type \| \| --- \| --- \| --- \| --- \| \| id \| Undefined. \| true \| string \| |
| **Request body**: None | **Response body**: [v202407alpha1GetCredentialGroupResponse](/v1/docs/credentials-vault-apis#getcredentialgroupresponse) |
| Name | Description | Required | Type |
| id | Undefined. | true | string |

## Credentials Vault Schemas

This API uses the following schemas.

#### protobufAny

| **Schema:** protobufAny | **Type:** object |
| --- | --- |
| **Properties:** \| Name \| Value \| \| --- \| --- \| \| typeUrl \| type: string \| \| value \| type: string format: byte \| |
| Name | Value |
| typeUrl | type: string |
| value | type: string format: byte |

#### rpcStatus

| **Schema:** rpcStatus | **Type:** object |
| --- | --- |
| **Properties:** \| Name \| Value \| \| --- \| --- \| \| code \| type: integer format: int32 \| \| message \| type: string \| \| details \| type: array items: $ref: [protobufAny](/v1/docs/credentials-vault-apis#protobufany) \| |
| Name | Value |
| code | type: integer format: int32 |
| message | type: string |
| details | type: array items: $ref: [protobufAny](/v1/docs/credentials-vault-apis#protobufany) |

#### PermissionEntry

| **Schema:** v202211PermissionEntry | **Type:** object |
| --- | --- |
| **Properties****(* = required)** \| Name \| Value \| \| --- \| --- \| \| capability * \| type: string description: String identifying capability that is granted of denied \| \| allowed * \| type: boolean description: Flag indicating whether operation is allowed \| |
| Name | Value |
| capability * | type: string description: String identifying capability that is granted of denied |
| allowed * | type: boolean description: Flag indicating whether operation is allowed |

#### Role

| **Schema:** v202211Role | **Type:** string |
| --- | --- |
| **Attributes:** \| Key \| Value \| \| --- \| --- \| \| enum \| ROLE_UNSPECIFIED, ROLE_MEMBER, ROLE_ADMINISTRATOR, ROLE_SUPER_ADMINISTRATOR \| \| default \| ROLE_UNSPECIFIED \| \| description \| • ROLE_UNSPECIFIED: Invalid value. • ROLE_MEMBER: Member • ROLE_ADMINISTRATOR: Administrator • ROLE_SUPER_ADMINISTRATOR: Super-administrator \| |
| Key | Value |
| enum | ROLE_UNSPECIFIED, ROLE_MEMBER, ROLE_ADMINISTRATOR, ROLE_SUPER_ADMINISTRATOR |
| default | ROLE_UNSPECIFIED |
| description | • ROLE_UNSPECIFIED: Invalid value. • ROLE_MEMBER: Member • ROLE_ADMINISTRATOR: Administrator • ROLE_SUPER_ADMINISTRATOR: Super-administrator |

#### User

| **Schema:** v202211User | **Type:** object |
| --- | --- |
| **Properties (* = required)** \| Name \| Value \| \| --- \| --- \| \| id \| type: string description: System generated unique identifier readOnly: true \| \| userEmail * \| type: string description: User e-mail address (serves also as username) \| \| userFullName * \| type: string description: Full name \| \| role \| $ref: [v202211Role](/v1/docs/credentials-vault-apis#role) \| \| permissions \| type: array items: $ref: [v202211PermissionEntry](/v1/docs/credentials-vault-apis#permissionentry) description: Optional list of permissions granted to the user \| \| filter \| type: string description: Optional JSON string defining filter for objects visible to the user \| \| lastLogin \| type: string format: date-time description: UTC Timestamp of user's last login session readOnly: true \| \| cdate \| type: string format: date-time description: Creation timestamp (UTC) readOnly: true \| \| edate \| type: string format: date-time description: Last modification timestamp (UTC) readOnly: true \| |
| Name | Value |
| id | type: string description: System generated unique identifier readOnly: true |
| userEmail * | type: string description: User e-mail address (serves also as username) |
| userFullName * | type: string description: Full name |
| role | $ref: [v202211Role](/v1/docs/credentials-vault-apis#role) |
| permissions | type: array items: $ref: [v202211PermissionEntry](/v1/docs/credentials-vault-apis#permissionentry) description: Optional list of permissions granted to the user |
| filter | type: string description: Optional JSON string defining filter for objects visible to the user |
| lastLogin | type: string format: date-time description: UTC Timestamp of user's last login session readOnly: true |
| cdate | type: string format: date-time description: Creation timestamp (UTC) readOnly: true |
| edate | type: string format: date-time description: Last modification timestamp (UTC) readOnly: true |

#### Secret

| **Schema:** v202312alpha1Secret | **Type:** object |
| --- | --- |
| **Properties****(* = required)** \| Name \| Value \| \| --- \| --- \| \| name * \| type: string description: The secret's name \| \| value * \| type: string description: The secret's actual value \| \| version * \| type: integer format: int64 description: The secret's version \| \| description \| type: string description: Purpose of this secret \| \| type \| $ref: [v202312alpha1SecretType](/v1/docs/credentials-vault-apis#secrettype) \| \| id * \| type: string description: The secret's identifier \| |
| Name | Value |
| name * | type: string description: The secret's name |
| value * | type: string description: The secret's actual value |
| version * | type: integer format: int64 description: The secret's version |
| description | type: string description: Purpose of this secret |
| type | $ref: [v202312alpha1SecretType](/v1/docs/credentials-vault-apis#secrettype) |
| id * | type: string description: The secret's identifier |

#### SecretType

| **Schema:** v202312alpha1SecretType | **Type:** string |
| --- | --- |
| **Attributes:** \| Key \| Value \| \| --- \| --- \| \| enum \| SECRET_TYPE_UNSPECIFIED, SECRET_TYPE_BASIC_AUTH, SECRET_TYPE_SNMP_V1, SECRET_TYPE_SNMP_V2C, SECRET_TYPE_SNMP_V3, SECRET_TYPE_STREAMING_TELEMETRY, SECRET_TYPE_BGP_MD5, SECRET_TYPE_API_TOKEN, SECRET_TYPE_OTHER \| \| default \| SECRET_TYPE_UNSPECIFIED \| |
| Key | Value |
| enum | SECRET_TYPE_UNSPECIFIED, SECRET_TYPE_BASIC_AUTH, SECRET_TYPE_SNMP_V1, SECRET_TYPE_SNMP_V2C, SECRET_TYPE_SNMP_V3, SECRET_TYPE_STREAMING_TELEMETRY, SECRET_TYPE_BGP_MD5, SECRET_TYPE_API_TOKEN, SECRET_TYPE_OTHER |
| default | SECRET_TYPE_UNSPECIFIED |

#### CredentialGroup

| **Schema:** v202407alpha1CredentialGroup | **Type:** object |
| --- | --- |
| **Properties (* = required)** \| Name \| Value \| \| --- \| --- \| \| id \| type: string \| \| name \| type: string \| \| version * \| type: integer format: int64 description: The secret's version \| \| description \| type: string description: Purpose of this secret \| \| type \| $ref: [v202312alpha1SecretType](/v1/docs/credentials-vault-apis#secrettype) \| \| cdate \| type: string format: date-time \| \| edate \| type: string format: date-time \| \| createdBy \| $ref: [v202211User](/v1/docs/credentials-vault-apis#user) \| \| credentials \| type: array items: $ref: [v202312alpha1Secret](/v1/docs/credentials-vault-apis#secret) \| \| labels \| type: array items: type: string \| |
| Name | Value |
| id | type: string |
| name | type: string |
| version * | type: integer format: int64 description: The secret's version |
| description | type: string description: Purpose of this secret |
| type | $ref: [v202312alpha1SecretType](/v1/docs/credentials-vault-apis#secrettype) |
| cdate | type: string format: date-time |
| edate | type: string format: date-time |
| createdBy | $ref: [v202211User](/v1/docs/credentials-vault-apis#user) |
| credentials | type: array items: $ref: [v202312alpha1Secret](/v1/docs/credentials-vault-apis#secret) |
| labels | type: array items: type: string |

#### GetCredentialGroupResponse

| **Schema:** v202407alpha1GetCredentialGroupResponse | **Type:** object |
| --- | --- |
| **Properties:** \| Name \| Value \| \| --- \| --- \| \| group \| $ref: [v202407alpha1CredentialGroup](/v1/docs/credentials-vault-apis#credentialgroup) \| |
| Name | Value |
| group | $ref: [v202407alpha1CredentialGroup](/v1/docs/credentials-vault-apis#credentialgroup) |

#### ListCredentialGroupResponse

| **Schema:** v202407alpha1ListCredentialGroupResponse | **Type:** object |
| --- | --- |
| **Properties**: \| Name \| Value \| \| --- \| --- \| \| groups \| type: array items: $ref: [v202407alpha1CredentialGroup](/v1/docs/credentials-vault-apis#credentialgroup) \| \| invalidCount \| type: integer format: int64 \| |
| Name | Value |
| groups | type: array items: $ref: [v202407alpha1CredentialGroup](/v1/docs/credentials-vault-apis#credentialgroup) |
| invalidCount | type: integer format: int64 |