API - Corsair

Every doppler.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Activity Logs

list

activityLogs.list List workplace activity log entries Risk: read

await corsair.doppler.api.activityLogs.list({});

Input

Name	Type	Required	Description
`page`	`string`	No	—
`perPage`	`number`	No	—

Output

Name	Type	Required	Description
`logs`	`object[]`	Yes	—
`page`	`number`	No	—

logs full type

{
  id?: string | null,
  text?: string | null,
  html?: string | null,
  created_at?: string | null,
  config?: string | null,
  environment?: string | null,
  project?: string | null,
  enclave_project?: string | null,
  enclave_environment?: string | null,
  enclave_config?: string | null,
  user?: {
  } | null,
  diff?: {
  } | null
}[]

retrieve

activityLogs.retrieve Retrieve a single activity log entry Risk: read

await corsair.doppler.api.activityLogs.retrieve({});

Input

Name	Type	Required	Description
`log`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`text`	`string`	No	—
`html`	`string`	No	—
`created_at`	`string`	No	—
`config`	`string`	No	—
`environment`	`string`	No	—
`project`	`string`	No	—
`enclave_project`	`string`	No	—
`enclave_environment`	`string`	No	—
`enclave_config`	`string`	No	—
`user`	`object`	No	—
`diff`	`object`	No	—

user full type

{
}

diff full type

{
}

Auth

me

auth.me Read information about the authenticated token Risk: read

await corsair.doppler.api.auth.me({});

Input: empty object Output

Name	Type	Required	Description
`slug`	`string`	No	—
`name`	`string`	No	—
`created_at`	`string`	No	—
`last_seen_at`	`string`	No	—
`type`	`string`	No	—
`token_preview`	`string`	No	—
`workplace`	`object`	No	—
`principal`	`object`	No	—

workplace full type

{
  slug?: string | null,
  name?: string | null
}

principal full type

{
  type?: string | null,
  slug?: string | null
}

Change Requests

list

changeRequests.list List change requests (Team/Enterprise plans only) Risk: read

await corsair.doppler.api.changeRequests.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`perPage`	`number`	No	—
`status`	`string[]`	No	—
`title`	`string`	No	—

Output: object[]

Output full type

{
}[]

Config Logs

get

configLogs.get Retrieve a config log entry, including its secret diff Risk: read

await corsair.doppler.api.configLogs.get({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`log`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`text`	`string`	No	—
`html`	`string`	No	—
`created_at`	`string`	No	—
`user`	`object`	No	—
`diff`	`object`	No	—

user full type

{
}

diff full type

{
}

list

configLogs.list List a config’s change-log entries Risk: read

await corsair.doppler.api.configLogs.list({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`page`	`number`	No	—
`perPage`	`number`	No	—

Output

Name	Type	Required	Description
`logs`	`object[]`	Yes	—
`page`	`number`	No	—

logs full type

{
  id?: string | null,
  text?: string | null,
  html?: string | null,
  created_at?: string | null,
  user?: {
  } | null,
  diff?: {
  } | null
}[]

rollback

configLogs.rollback Roll a config back to a prior log entry’s state Risk: write

await corsair.doppler.api.configLogs.rollback({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`log`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`text`	`string`	No	—
`html`	`string`	No	—
`created_at`	`string`	No	—
`user`	`object`	No	—
`diff`	`object`	No	—

user full type

{
}

diff full type

{
}

Configs

clone

configs.clone Clone a config into a new branch config Risk: write

await corsair.doppler.api.configs.clone({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`slug`	`string`	No	—
`project`	`string`	No	—
`environment`	`string`	No	—
`root`	`boolean`	No	—
`inheritable`	`boolean`	No	—
`inheriting`	`boolean`	No	—
`inherits`	`any[]`	No	—
`inheritedBy`	`any[]`	No	—
`locked`	`boolean`	No	—
`initial_fetch_at`	`string`	No	—
`last_fetch_at`	`string`	No	—
`created_at`	`string`	No	—

create

configs.create Create a branch config within an environment Risk: write

await corsair.doppler.api.configs.create({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`environment`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`slug`	`string`	No	—
`project`	`string`	No	—
`environment`	`string`	No	—
`root`	`boolean`	No	—
`inheritable`	`boolean`	No	—
`inheriting`	`boolean`	No	—
`inherits`	`any[]`	No	—
`inheritedBy`	`any[]`	No	—
`locked`	`boolean`	No	—
`initial_fetch_at`	`string`	No	—
`last_fetch_at`	`string`	No	—
`created_at`	`string`	No	—

delete

configs.delete Permanently delete a config and its secrets Risk: destructive

await corsair.doppler.api.configs.delete({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

get

configs.get Retrieve a config Risk: read

await corsair.doppler.api.configs.get({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`slug`	`string`	No	—
`project`	`string`	No	—
`environment`	`string`	No	—
`root`	`boolean`	No	—
`inheritable`	`boolean`	No	—
`inheriting`	`boolean`	No	—
`inherits`	`any[]`	No	—
`inheritedBy`	`any[]`	No	—
`locked`	`boolean`	No	—
`initial_fetch_at`	`string`	No	—
`last_fetch_at`	`string`	No	—
`created_at`	`string`	No	—

list

configs.list List a project’s configs Risk: read

await corsair.doppler.api.configs.list({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`environment`	`string`	No	—
`page`	`number`	No	—
`perPage`	`number`	No	—

Output

Name	Type	Required	Description
`configs`	`object[]`	Yes	—
`page`	`number`	No	—

configs full type

{
  name: string,
  slug?: string | null,
  project?: string | null,
  environment?: string | null,
  root?: boolean | null,
  inheritable?: boolean | null,
  inheriting?: boolean | null,
  inherits?: any[] | null,
  inheritedBy?: any[] | null,
  locked?: boolean | null,
  initial_fetch_at?: string | null,
  last_fetch_at?: string | null,
  created_at?: string | null
}[]

lock

configs.lock Lock a config so it cannot be renamed or deleted Risk: write

await corsair.doppler.api.configs.lock({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`slug`	`string`	No	—
`project`	`string`	No	—
`environment`	`string`	No	—
`root`	`boolean`	No	—
`inheritable`	`boolean`	No	—
`inheriting`	`boolean`	No	—
`inherits`	`any[]`	No	—
`inheritedBy`	`any[]`	No	—
`locked`	`boolean`	No	—
`initial_fetch_at`	`string`	No	—
`last_fetch_at`	`string`	No	—
`created_at`	`string`	No	—

unlock

configs.unlock Unlock a config so it can be renamed or deleted Risk: write

await corsair.doppler.api.configs.unlock({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`slug`	`string`	No	—
`project`	`string`	No	—
`environment`	`string`	No	—
`root`	`boolean`	No	—
`inheritable`	`boolean`	No	—
`inheriting`	`boolean`	No	—
`inherits`	`any[]`	No	—
`inheritedBy`	`any[]`	No	—
`locked`	`boolean`	No	—
`initial_fetch_at`	`string`	No	—
`last_fetch_at`	`string`	No	—
`created_at`	`string`	No	—

update

configs.update Rename a config Risk: write

await corsair.doppler.api.configs.update({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`slug`	`string`	No	—
`project`	`string`	No	—
`environment`	`string`	No	—
`root`	`boolean`	No	—
`inheritable`	`boolean`	No	—
`inheriting`	`boolean`	No	—
`inherits`	`any[]`	No	—
`inheritedBy`	`any[]`	No	—
`locked`	`boolean`	No	—
`initial_fetch_at`	`string`	No	—
`last_fetch_at`	`string`	No	—
`created_at`	`string`	No	—

Dynamic Secrets

revokeLease

dynamicSecrets.revokeLease Revoke a leased dynamic secret credential Risk: destructive

await corsair.doppler.api.dynamicSecrets.revokeLease({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`dynamicSecret`	`string`	Yes	—
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

Environments

create

environments.create Create an environment within a project Risk: write

await corsair.doppler.api.environments.create({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`name`	`string`	Yes	—
`slug`	`string`	Yes	—
`personalConfigs`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`project`	`string`	No	—
`initial_fetch_at`	`string`	No	—
`created_at`	`string`	No	—
`personal_configs`	`boolean`	No	—

delete

environments.delete Permanently delete an environment and its configs Risk: destructive

await corsair.doppler.api.environments.delete({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`environment`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

get

environments.get Retrieve an environment Risk: read

await corsair.doppler.api.environments.get({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`environment`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`project`	`string`	No	—
`initial_fetch_at`	`string`	No	—
`created_at`	`string`	No	—
`personal_configs`	`boolean`	No	—

list

environments.list List a project’s environments Risk: read

await corsair.doppler.api.environments.list({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—

Output: object[]

Output full type

{
  id: string,
  slug?: string | null,
  name?: string | null,
  project?: string | null,
  initial_fetch_at?: string | null,
  created_at?: string | null,
  personal_configs?: boolean | null
}[]

rename

environments.rename Rename an environment’s display name or slug Risk: write

await corsair.doppler.api.environments.rename({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`environment`	`string`	Yes	—
`name`	`string`	No	—
`slug`	`string`	No	—
`personalConfigs`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`project`	`string`	No	—
`initial_fetch_at`	`string`	No	—
`created_at`	`string`	No	—
`personal_configs`	`boolean`	No	—

Groups

deleteMember

groups.deleteMember Remove a member from a workplace group Risk: destructive

await corsair.doppler.api.groups.deleteMember({});

Input

Name	Type	Required	Description
`group`	`string`	Yes	—
`type`	`workplace_user \| group \| invite \| service_account`	Yes	—
`memberSlug`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

Integrations

list

integrations.list List third-party integrations Risk: read

await corsair.doppler.api.integrations.list({});

Input: empty object Output: object[]

Output full type

{
}[]

Invites

list

invites.list List pending workplace invites Risk: read

await corsair.doppler.api.invites.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`perPage`	`number`	No	—

Output

Name	Type	Required	Description
`invites`	`object[]`	Yes	—
`page`	`number`	No	—

invites full type

{
}[]

Project Members

delete

projectMembers.delete Remove a member from a project Risk: destructive

await corsair.doppler.api.projectMembers.delete({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`type`	`workplace_user \| group \| invite \| service_account`	Yes	—
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

get

projectMembers.get Retrieve a project member Risk: read

await corsair.doppler.api.projectMembers.get({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`type`	`workplace_user \| group \| invite \| service_account`	Yes	—
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`type`	`string`	No	—
`slug`	`string`	No	—
`role`	`object`	No	—
`environments`	`any[]`	No	—

role full type

{
}

list

projectMembers.list List a project’s members Risk: read

await corsair.doppler.api.projectMembers.list({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`page`	`number`	No	—
`perPage`	`number`	No	—

Output

Name	Type	Required	Description
`members`	`object[]`	Yes	—
`page`	`number`	No	—

members full type

{
  type?: string | null,
  slug?: string | null,
  role?: {
  } | null,
  environments?: any[] | null
}[]

Project Roles

get

projectRoles.get Retrieve a project-level role Risk: read

await corsair.doppler.api.projectRoles.get({});

Input

Name	Type	Required	Description
`role`	`string`	Yes	—

Output

Name	Type	Required	Description
`identifier`	`string`	No	—
`name`	`string`	No	—
`permissions`	`string[]`	No	—
`created_at`	`string`	No	—
`is_custom_role`	`boolean`	No	—

list

projectRoles.list List project-level roles Risk: read

await corsair.doppler.api.projectRoles.list({});

Input: empty object Output: object[]

Output full type

{
  identifier?: string | null,
  name?: string | null,
  permissions?: string[] | null,
  created_at?: string | null,
  is_custom_role?: boolean | null
}[]

listPermissions

projectRoles.listPermissions List permissions grantable to a project-level role Risk: read

await corsair.doppler.api.projectRoles.listPermissions({});

Input: empty object Output: string[]

Projects

create

projects.create Create a project Risk: write

await corsair.doppler.api.projects.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`description`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`description`	`string`	No	—
`created_at`	`string`	No	—

delete

projects.delete Permanently delete a project and everything in it Risk: destructive

await corsair.doppler.api.projects.delete({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

get

projects.get Retrieve a project Risk: read

await corsair.doppler.api.projects.get({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`description`	`string`	No	—
`created_at`	`string`	No	—

list

projects.list List projects Risk: read

await corsair.doppler.api.projects.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`perPage`	`number`	No	—

Output

Name	Type	Required	Description
`projects`	`object[]`	Yes	—
`page`	`number`	No	—

projects full type

{
  id: string,
  slug?: string | null,
  name?: string | null,
  description?: string | null,
  created_at?: string | null
}[]

update

projects.update Update a project’s name or description Risk: write

await corsair.doppler.api.projects.update({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`description`	`string`	No	—
`created_at`	`string`	No	—

Secrets

delete

secrets.delete Delete a secret Risk: destructive

await corsair.doppler.api.secrets.delete({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

download

secrets.download Download a config’s secrets in a given format Risk: read

await corsair.doppler.api.secrets.download({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`format`	`json \| env \| yaml \| docker \| env-no-quotes`	No	—
`nameTransformer`	`string`	No	—
`includeDynamicSecrets`	`boolean`	No	—
`dynamicSecretsTtlSec`	`number`	No	—
`secrets`	`string[]`	No	—

Output: object

Output full type

{
}

get

secrets.get Retrieve a single secret’s value Risk: read

await corsair.doppler.api.secrets.get({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`raw`	`string`	No	—
`computed`	`string`	No	—
`note`	`string`	No	—
`rawVisibility`	`string`	No	—
`computedVisibility`	`string`	No	—
`rawValueType`	`object`	No	—
`computedValueType`	`object`	No	—
`name`	`string`	Yes	—

rawValueType full type

{
}

computedValueType full type

{
}

list

secrets.list List a config’s secrets, values included Risk: read

await corsair.doppler.api.secrets.list({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`includeDynamicSecrets`	`boolean`	No	—
`includeManagedSecrets`	`boolean`	No	—

Output: object

Output full type

{
}

names

secrets.names List a config’s secret names, without values Risk: read

await corsair.doppler.api.secrets.names({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`includeDynamicSecrets`	`boolean`	No	—
`includeManagedSecrets`	`boolean`	No	—

Output: string[]

update

secrets.update Bulk-set (or delete, via null) secrets in a config Risk: write

await corsair.doppler.api.secrets.update({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`secrets`	`object`	Yes	—

secrets full type

{
}

Output: object

Output full type

{
}

updateNote

secrets.updateNote Set a secret’s note (project-scoped route) Risk: write

await corsair.doppler.api.secrets.updateNote({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`secret`	`string`	Yes	—
`note`	`string`	Yes	—

Output

Name	Type	Required	Description
`secret`	`string`	No	—
`note`	`string`	No	—

updateNoteViaConfig

secrets.updateNoteViaConfig Set a secret’s note (config-scoped route) Risk: write

await corsair.doppler.api.secrets.updateNoteViaConfig({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`secret`	`string`	Yes	—
`note`	`string`	Yes	—

Output

Name	Type	Required	Description
`secret`	`string`	No	—
`note`	`string`	No	—

Service Tokens

create

serviceTokens.create Create a service token for a config Risk: write

await corsair.doppler.api.serviceTokens.create({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`name`	`string`	Yes	—
`access`	`read \| read/write`	No	—
`expireAt`	`string`	No	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`slug`	`string`	No	—
`access`	`string`	No	—
`created_at`	`string`	No	—
`key`	`string`	No	—
`project`	`string`	No	—
`environment`	`string`	No	—
`config`	`string`	No	—
`expires_at`	`string`	No	—
`last_seen_at`	`string`	No	—
`token_preview`	`string`	No	—

delete

serviceTokens.delete Revoke a service token Risk: destructive

await corsair.doppler.api.serviceTokens.delete({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

list

serviceTokens.list List a config’s service tokens Risk: read

await corsair.doppler.api.serviceTokens.list({});

Input

Name	Type	Required	Description
`project`	`string`	Yes	—
`config`	`string`	Yes	—

Output: object[]

Output full type

{
  name?: string | null,
  slug?: string | null,
  access?: string | null,
  created_at?: string | null,
  key?: string | null,
  project?: string | null,
  environment?: string | null,
  config?: string | null,
  expires_at?: string | null,
  last_seen_at?: string | null,
  token_preview?: string | null
}[]

createEncrypted

share.createEncrypted Create a Doppler Share link from a caller-encrypted payload (zero-knowledge) Risk: write

await corsair.doppler.api.share.createEncrypted({});

Input

Name	Type	Required	Description
`encryptedSecret`	`string`	Yes	—
`hashedPassword`	`string`	Yes	—
`encryptionKdf`	`pbkdf2`	No	—
`encryptionSaltRounds`	`1000000`	No	—
`expireViews`	`number \| -1`	No	—
`expireDays`	`number`	No	—

Output

Name	Type	Required	Description
`url`	`string`	No	—
`authenticated_url`	`string`	No	—
`password`	`string`	No	—

createPlain

share.createPlain Create a Doppler Share link from a plaintext secret Risk: write

await corsair.doppler.api.share.createPlain({});

Input

Name	Type	Required	Description
`secret`	`string`	Yes	—
`expireViews`	`number \| -1`	No	—
`expireDays`	`number`	No	—

Output

Name	Type	Required	Description
`url`	`string`	No	—
`authenticated_url`	`string`	No	—
`password`	`string`	No	—

Webhooks

add

webhooks.add Create a webhook Risk: write

await corsair.doppler.api.webhooks.add({});

Input

Name	Type	Required	Description
`project`	`string`	No	—
`url`	`string`	Yes	—
`name`	`string`	No	—
`secret`	`string`	No	—
`authentication`	`object`	No	—
`payload`	`string`	No	—
`enableConfigs`	`string[]`	No	—

authentication full type

{
  type: None | Bearer | Basic,
  token?: string,
  username?: string,
  password?: string
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`url`	`string`	No	—
`enabled`	`boolean`	No	—
`hasSecret`	`boolean`	No	—
`authentication`	`any`	No	—
`enabledConfigs`	`any[]`	No	—
`canManage`	`boolean`	No	—

delete

webhooks.delete Permanently delete a webhook Risk: destructive

await corsair.doppler.api.webhooks.delete({});

Input

Name	Type	Required	Description
`project`	`string`	No	—
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

disable

webhooks.disable Disable a webhook Risk: write

await corsair.doppler.api.webhooks.disable({});

Input

Name	Type	Required	Description
`project`	`string`	No	—
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`url`	`string`	No	—
`enabled`	`boolean`	No	—
`hasSecret`	`boolean`	No	—
`authentication`	`any`	No	—
`enabledConfigs`	`any[]`	No	—
`canManage`	`boolean`	No	—

enable

webhooks.enable Enable a webhook Risk: write

await corsair.doppler.api.webhooks.enable({});

Input

Name	Type	Required	Description
`project`	`string`	No	—
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`url`	`string`	No	—
`enabled`	`boolean`	No	—
`hasSecret`	`boolean`	No	—
`authentication`	`any`	No	—
`enabledConfigs`	`any[]`	No	—
`canManage`	`boolean`	No	—

get

webhooks.get Retrieve a webhook Risk: read

await corsair.doppler.api.webhooks.get({});

Input

Name	Type	Required	Description
`project`	`string`	No	—
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`url`	`string`	No	—
`enabled`	`boolean`	No	—
`hasSecret`	`boolean`	No	—
`authentication`	`any`	No	—
`enabledConfigs`	`any[]`	No	—
`canManage`	`boolean`	No	—

list

webhooks.list List webhooks Risk: read

await corsair.doppler.api.webhooks.list({});

Input

Name	Type	Required	Description
`project`	`string`	No	—

Output: object[]

Output full type

{
  id: string,
  name?: string | null,
  url?: string | null,
  enabled?: boolean | null,
  hasSecret?: boolean | null,
  authentication?: any | null,
  enabledConfigs?: any[] | null,
  canManage?: boolean | null
}[]

update

webhooks.update Update a webhook Risk: write

await corsair.doppler.api.webhooks.update({});

Input

Name	Type	Required	Description
`project`	`string`	No	—
`slug`	`string`	Yes	—
`url`	`string`	No	—
`name`	`string`	No	—
`secret`	`string`	No	—
`authentication`	`object`	No	—
`payload`	`string`	No	—
`enableConfigs`	`string[]`	No	—
`disableConfigs`	`string[]`	No	—

authentication full type

{
  type: None | Bearer | Basic,
  token?: string,
  username?: string,
  password?: string
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`url`	`string`	No	—
`enabled`	`boolean`	No	—
`hasSecret`	`boolean`	No	—
`authentication`	`any`	No	—
`enabledConfigs`	`any[]`	No	—
`canManage`	`boolean`	No	—

Workplace

get

workplace.get Retrieve the workplace Risk: read

await corsair.doppler.api.workplace.get({});

Input: empty object Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`billing_email`	`string`	No	—
`security_email`	`string`	No	—

update

workplace.update Update the workplace’s name, billing email, or security email Risk: write

await corsair.doppler.api.workplace.update({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`billingEmail`	`string`	No	—
`securityEmail`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`billing_email`	`string`	No	—
`security_email`	`string`	No	—

Workplace Roles

get

workplaceRoles.get Retrieve a workplace role Risk: read

await corsair.doppler.api.workplaceRoles.get({});

Input

Name	Type	Required	Description
`role`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`permissions`	`string[]`	No	—

list

workplaceRoles.list List workplace roles Risk: read

await corsair.doppler.api.workplaceRoles.list({});

Input: empty object Output: object[]

Output full type

{
  name?: string | null,
  permissions?: string[] | null
}[]

listPermissions

workplaceRoles.listPermissions List permissions grantable to a workplace role Risk: read

await corsair.doppler.api.workplaceRoles.listPermissions({});

Input: empty object Output: string[]

Workplace Users

get

workplaceUsers.get Retrieve a workplace user by id Risk: read

await corsair.doppler.api.workplaceUsers.get({});

Input

Name	Type	Required	Description
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`access`	`string`	No	—
`created_at`	`string`	No	—
`user`	`object`	No	—

user full type

{
  id?: string | null,
  email?: string | null,
  name?: string | null,
  username?: string | null
}

list

workplaceUsers.list List users in the workplace Risk: read

await corsair.doppler.api.workplaceUsers.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`email`	`string`	No	—

Output

Name	Type	Required	Description
`workplace_users`	`object[]`	Yes	—
`page`	`number`	No	—

workplace_users full type

{
  access?: string | null,
  created_at?: string | null,
  user?: {
    id?: string | null,
    email?: string | null,
    name?: string | null,
    username?: string | null
  } | null
}[]

​Activity Logs

​list

​retrieve

​Auth

​me

​Change Requests

​list

​Config Logs

​get

​list

​rollback

​Configs

​clone

​create

​delete

​get

​list

​lock

​unlock

​update

​Dynamic Secrets

​revokeLease

​Environments

​create

​delete

​get

​list

​rename

​Groups

​deleteMember

​Integrations

​list

​Invites

​list

​Project Members

​delete

​get

​list

​Project Roles

​get

​list

​listPermissions

​Projects

​create

​delete

​get

​list

​update

​Secrets

​delete

​download

​get

​list

​names

​update

​updateNote

​updateNoteViaConfig

​Service Tokens

​create

​delete

​list

​Share

​createEncrypted

​createPlain

​Webhooks

​add

​delete

​disable

​enable

​get

​list

​update

​Workplace

​get

​update

​Workplace Roles

​get

​list

​listPermissions

​Workplace Users

Activity Logs

list

retrieve

Auth

me

Change Requests

list

Config Logs

get

list

rollback

Configs

clone

create

delete

get

list

lock

unlock

update

Dynamic Secrets

revokeLease

Environments

create

delete

get

list

rename

Groups

deleteMember

Integrations

list

Invites

list

Project Members

delete

get

list

Project Roles

get

list

listPermissions

Projects

create

delete

get

list

update

Secrets

delete

download

get

list

names

update

updateNote

updateNoteViaConfig

Service Tokens

create

delete

list

Share

createEncrypted

createPlain

Webhooks

add

delete

disable

enable

get

list

update

Workplace

get

update

Workplace Roles

get

list

listPermissions

Workplace Users