@infisical/sdk

Open-source, end-to-end encrypted tool to manage secrets and configs across your team and infrastructure.

Table of Contents

• Links

• Basic Usage

• Secrets

• Get Secrets

• Get Secret

• Create Secret

• Update Secret

• Delete Secret

Links

• Infisical

Basic Usage

import express from "express";

import { InfisicalClient, LogLevel } from "@infisical/sdk";

const app = express();

const PORT = 3000;

const client = new InfisicalClient({
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET",
    logLevel: LogLevel.Error
});

app.get("/", async (req, res) => {
    // access value

    const name = await client.getSecret({
        environment: "dev",
        projectId: "656dba7f979ebd6652586669",
        path: "/",
        type: "shared",
        secretName: "NAME"
    });

    res.send(`Hello! My name is: ${name.secretValue}`);
});

app.listen(PORT, async () => {
    // initialize client

    console.log(`App listening on port ${port}`);
});

Installation

$ npm install @infisical/sdk

Configuration

Import the SDK and create a client instance with your Machine Identity.

const { InfisicalClient, LogLevel } = require("@infisical/sdk");

const client = new InfisicalClient({
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET",
    logLevel: LogLevel.Error
});

Using ES6:

import { InfisicalClient } from "@infisical/sdk";

const client = new InfisicalClient({
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET",
    logLevel: LogLevel.Error
});

// your app logic

Options

| Parameter | Type | Description |

| ---------- | --------- | -------------------------------------------------------------------------- |

| clientId | string | Your machine identity client ID. |

| clientSecret | string | Your machine identity client secret. |

| accessToken | string | OPTIONAL: An access token obtained from the machine identity login endpoint. |

| siteUrl | string | Your self-hosted Infisical site URL. Default: https://app.infisical.com. |

| logLevel | enum | The level of logs you wish to log The logs are derived from Rust, as we have written our base SDK in Rust. Default: Error. |

Secrets

Get Secrets

const secrets = await client.listSecrets({
    environment: "dev",
    projectId: "656dba7f979ebd6652586669",
    path: "/foo/bar/",
    includeImports: false
});

Retrieve all secrets within a given environment and folder path. The service token used must have access to the given path and environment.

Parameters

All parameters are passed as options (an object).

• environment The slug name (dev, prod, etc) of the environment from where secrets should be fetched from
• projectId (string): The project ID where the secret lives in.
• secretName The name of the secret you want to get.
• path The path from where secrets should be fetched from
• includeImports (boolean, optional): Whether or not to include imported secrets from the current path. Read about secret import.

Get Secret

Retrieve a secret from Infisical:

const secret = await client.getSecret({
    environment: "dev",
    projectId: "656dba7f979ebd6652586669",
    secretName: "API_KEY",
    path: "/",
    type: "shared"
});

const value = secret.secretValue; // get its value

By default, getSecret() fetches and returns a shared secret.

To explicitly retrieve a personal secret:

const secret = await client.getSecret({
    environment: "dev",
    projectId: "656dba7f979ebd6652586669",
    secretName: "API_KEY",
    path: "/",
    type: "personal"
});

const value = secret.secretValue; // get its value

Parameters

All parameters are passed as options (an object).

• secretName: The key of the secret to retrieve.
• projectId: The project ID where the secret lives in.
• environment The slug name (dev, prod, etc) of the environment from where secrets should be fetched from
• path The path from where secrets should be fetched from
• type (string, optional): The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".

Create Secret

Create a new secret in Infisical:

const newApiKey = await client.createSecret({
    projectId: "656dba7f979ebd6652586669",
    environment: "dev",
    secretName: "API_KEY",
    secretValue: "SECRET VALUE",
    path: "/",
    type: "shared"
});

Parameters

All parameters are passed as options (an object).

• secretName (string): The key of the secret to create.
• secretValue (string): The value of the secret.
• options (object, optional): An options object to specify the type of secret.
• projectId (string): The project ID where the secret lives in.
• environment The slug name (dev, prod, etc) of the environment where secret should be created
• path The path from where secret should be created.
• type (string, optional): The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared". A personal secret can only be created if a shared secret with the same name exists.

Update Secret

Update an existing secret in Infisical:

const updatedApiKey = await client.updateSecret({
    secretName: "API_KEY",
    secretValue: "NEW SECRET VALUE",
    projectId: "656dba7f979ebd6652586669",
    environment: "dev",
    path: "/",
    type: "shared"
});

Parameters

• secretName (string): The key of the secret to update.
• secretValue (string): The new value of the secret.
• options (object, optional): An options object to specify the type of secret.
• environment The slug name (dev, prod, etc) of the environment where secret should be updated.
• projectId (string): The project ID where the secret lives in.
• path The path from where secret should be updated.
• type (string, optional): The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".

Delete Secret

Delete a secret in Infisical:

const deletedSecret = await client.deleteSecret({
    secretName: "API_KEY",

    environment: "dev",
    projectId: "656dba7f979ebd6652586669",
    path: "/",

    type: "shared"
});

Parameters

• secretName (string): The key of the secret to delete.
• projectId (string): The project ID where the secret lives in.
• options (object, optional): An options object to specify the type of secret to delete.
• environment The slug name (dev, prod, etc) of the environment where secret should be deleted.
• path The path from where secret should be deleted.
• type (string, optional): The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared". Note that deleting a shared secret also deletes all associated personal secrets.

License

Infisical Node.js SDK is distributed under the terms of the MIT license.