caprover-lib/dist/api/CaproverApi.d.ts

A library to communicate with CapRover instances

/// <reference types="node" />
import { ReadStream } from 'fs';
import { IRegistryInfo } from '../models/IRegistryInfo';
import { ICaptainDefinition } from '../models/ICaptainDefinition';
import { IVersionInfo } from '../models/IVersionInfo';
import { IAppDef } from '../models/AppDef';
import IBuildLogs from '../models/IBuildLogs';
export interface CaproverApiParams {
    baseUrl: string;
    password?: string;
    debug?: boolean;
}
export declare class CaproverApi {
    private authToken;
    private http;
    constructor({ baseUrl, password, debug, }: CaproverApiParams);
    callApi(path: string, method: 'GET' | 'POST', data: any): Promise<any>;
    destroy(): void;
    setAuthToken(authToken: string): void;
    isLoggedIn(): boolean;
    getAuthToken(password: string): Promise<string>;
    getCaptainInfo(): Promise<any>;
    updateRootDomain(rootDomain: string): Promise<any>;
    enableRootSsl(emailAddress: string): Promise<any>;
    forceSsl(isEnabled: boolean): Promise<any>;
    getAllApps(): Promise<any>;
    fetchBuildLogs(appName: string): Promise<IBuildLogs>;
    uploadAppData(appName: string, file: ReadStream, gitHash: string): Promise<any>;
    uploadCaptainDefinitionContent(appName: string, captainDefinition: ICaptainDefinition, gitHash: string, detached: boolean): Promise<any>;
    updateConfigAndSave(appName: string, appDefinition: IAppDef): Promise<any>;
    registerNewApp(appName: string, hasPersistentData: boolean): Promise<any>;
    deleteApp(appName: string): Promise<any>;
    enableSslForBaseDomain(appName: string): Promise<any>;
    attachNewCustomDomainToApp(appName: string, customDomain: string): Promise<any>;
    enableSslForCustomDomain(appName: string, customDomain: string): Promise<any>;
    removeCustomDomain(appName: string, customDomain: string): Promise<any>;
    getLoadBalancerInfo(): Promise<any>;
    getNetDataInfo(): Promise<any>;
    updateNetDataInfo(netDataInfo: any): Promise<any>;
    changePass(oldPassword: string, newPassword: string): Promise<any>;
    getVersionInfo(): Promise<IVersionInfo>;
    performUpdate(latestVersion: string): Promise<any>;
    getNginxConfig(): Promise<any>;
    setNginxConfig(customBase: string, customCaptain: string): Promise<any>;
    getUnusedImages(mostRecentLimit: number): Promise<any>;
    deleteImages(imageIds: string[]): Promise<any>;
    getDockerRegistries(): Promise<any>;
    enableSelfHostedDockerRegistry(): Promise<any>;
    disableSelfHostedDockerRegistry(): Promise<any>;
    addDockerRegistry(dockerRegistry: IRegistryInfo): Promise<any>;
    updateDockerRegistry(dockerRegistry: IRegistryInfo): Promise<any>;
    deleteDockerRegistry(registryId: string): Promise<any>;
    setDefaultPushDockerRegistry(registryId: string): Promise<any>;
    getAllNodes(): Promise<any>;
    addDockerNode(nodeType: string, privateKey: string, remoteNodeIpAddress: string, captainIpAddress: string): Promise<any>;
}
//# sourceMappingURL=CaproverApi.d.ts.map