@piiano/vault-client/dist/generated/services/ConfigVarsClient.d.ts

Piiano Vault generated typescript client

import type { ConfVar } from '../models/ConfVar';
import type { ConfVarValue } from '../models/ConfVarValue';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class ConfigVarsClient {
    readonly httpRequest: BaseHttpRequest;
    constructor(httpRequest: BaseHttpRequest);
    /**
     * Clear configuration variables
     * Clears all dynamic configuration variables.
     *
     * :::note
     * This API is unavailable in the hosted version of Vault.
     * :::
     *
     * The role performing this operation must have the `CapConfvarWriter` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities are used to control access to operations.
     * @returns any The request is successful.
     * @throws ApiError
     */
    clearAllConfVars({ customAudit, additionalHeaders, }?: {
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<any>;
    /**
     * Get configuration variable
     * Gets a dynamic configuration variable by name.
     *
     * :::note
     * This API is unavailable in the hosted version of Vault.
     * :::
     *
     * The variables that can be obtained are:
     *
     * - `log_level`
     *
     * The role that performs this operation must have the `CapConfvarReader` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities are used to control access to operations.
     * @returns ConfVar The request is successful.
     * @throws ApiError
     */
    getConfVar({ name, customAudit, additionalHeaders, }: {
        /**
         * The name of the configuration variable.
         */
        name: string;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<ConfVar>;
    /**
     * Set configuration variable
     * Sets a dynamic configuration variable by name.
     *
     * :::note
     * This API is unavailable in the hosted version of Vault.
     * :::
     *
     * The variables that can be set are:
     *
     * - `log_level` which can take the values of `debug`, `info`, `warn`, and `error`.
     * - `trace_sql` Indicates whether sql logs are enabled. values are `true` or `false`.
     *
     * The role that performs this operation must have the `CapConfvarWriter` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities are used to control access to operations.
     * @returns any The request is successful.
     * @throws ApiError
     */
    setConfVar({ name, requestBody, customAudit, additionalHeaders, }: {
        /**
         * The name of the configuration variable.
         */
        name: string;
        /**
         * Value of the configuration.
         */
        requestBody: ConfVarValue;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<any>;
}
//# sourceMappingURL=ConfigVarsClient.d.ts.map