Secret

Fetch a secret

get/secret/{secretId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/secret/{secretId}/fetch
  • Auth: HTTP bearer

Path parameters

secretIdstring required

The ID of the secret to retrieve

Response

The secret was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

blueprintIdstring nullable

The ID of the blueprint

kind'shared' | 'personal'

The kind of the secret

type'plain' | 'basic' | 'bearer' | 'jwt' | 'oauth' | 'template' | 'reference'

The type of the secret

configobject

The config of the secret (config.clientSecret is returned as '********' if configured, null otherwise)

visibility'private' | 'protected' | 'public'

The visibility of the secret

Changes

No recorded changes to this operation across all 1 revision of this API.