Class ApisClient

constructor

• new ApisClient(config): ApisClient

• Parameters

  • config: ApisConfig

  Returns ApisClient

authToken

config

operationsClient

subscriptionClient

create

• create(createApiData): Promise<WleApi>

• Create new api deployment

  Parameters

  • createApiData: Omit<Pick<WleApi, "port" | "name" | "image" | "dockerConfigBase64">, "env"> & Partial<Omit<WleApi, "env">> & {
        env: {
            [k: string]: string;
        };
    }

  Returns Promise<WleApi>

delete

• delete(apiName): Promise<void>

• Delete a single api resource. Please note, that an Api which is actively used by a Pages deployment cannot be removed.

  Parameters

  • apiName: string

  Returns Promise<void>

  Api Name

  jobId

get

• get(apiName): Promise<WleApi>

• Get a single API deployment

  Parameters

  • apiName: string

  Returns Promise<WleApi>

list

• list(): Promise<WleApi[]>

• List all apis available to the user

  Returns Promise<WleApi[]>

update

• update(data): Promise<WleApi>

• Create new api deployment

  Parameters

  • data: {
        name: string;
        updateEnv: boolean;
        [key: string]: any;
    }

    • [key: string]: any

    • name: string

    • updateEnv: boolean

  Returns Promise<WleApi>