Skip to content

fix(klipper): send X-Api-Key header on all Moonraker requests #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DMontgomery40 merged 1 commit into from
Oct 6, 2026
Merged

fix(klipper): send X-Api-Key header on all Moonraker requests #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions src/printers/klipper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,25 @@ function encodePath(filename: string): string {
export class KlipperImplementation extends GenericPrinterImplementation {
protected readonly printerLabel = "Klipper/Moonraker";

protected authHeaders(apiKey: string): Record<string, unknown> {
return apiKey ? { headers: { "X-Api-Key": apiKey } } : {};
}

async getStatus(host: string, port: string, apiKey: string) {
const url = `http://${host}:${port}/printer/info`;
const response = await this.apiClient.get(url);
const response = await this.apiClient.get(url, this.authHeaders(apiKey));
return response.data;
}

async getFiles(host: string, port: string, apiKey: string) {
const url = `http://${host}:${port}/server/files/list`;
const response = await this.apiClient.get(url);
const response = await this.apiClient.get(url, this.authHeaders(apiKey));
return response.data;
}

async getFile(host: string, port: string, apiKey: string, filename: string) {
const url = `http://${host}:${port}/server/files/metadata?filename=${encodeURIComponent(filename)}`;
const response = await this.apiClient.get(url);
const response = await this.apiClient.get(url, this.authHeaders(apiKey));
return response.data;
}

Expand All @@ -35,7 +39,10 @@ export class KlipperImplementation extends GenericPrinterImplementation {
protected async readPrinterState(host: string, port: string, apiKey: string): Promise<GenericPrinterState> {
let data: any;
try {
data = (await this.apiClient.get(`http://${host}:${port}/printer/objects/query?webhooks&print_stats`)).data;
data = (await this.apiClient.get(
`http://${host}:${port}/printer/objects/query?webhooks&print_stats`,
this.authHeaders(apiKey)
)).data;
} catch (error) {
throw new Error(`Cannot read Klipper/Moonraker printer state; nothing was sent: ${(error as Error).message}`);
}
Expand All @@ -60,7 +67,11 @@ export class KlipperImplementation extends GenericPrinterImplementation {
}

protected async downloadRemoteFile(host: string, port: string, apiKey: string, filename: string, destination: string): Promise<void> {
await this.downloadToFile(`http://${host}:${port}/server/files/gcodes/${encodePath(filename)}`, {}, destination);
await this.downloadToFile(
`http://${host}:${port}/server/files/gcodes/${encodePath(filename)}`,
apiKey ? { "X-Api-Key": apiKey } : {},
destination
);
}

/** Current Moonraker returns {result:{item}}; older releases returned result "success". */
Expand All @@ -77,7 +88,8 @@ export class KlipperImplementation extends GenericPrinterImplementation {

const response = await this.apiClient.post(url, formData as any, {
headers: {
...formData.getHeaders()
...formData.getHeaders(),
...(apiKey ? { "X-Api-Key": apiKey } : {})
}
});

Expand All @@ -87,15 +99,15 @@ export class KlipperImplementation extends GenericPrinterImplementation {
protected async rawStartJob(host: string, port: string, apiKey: string, filename: string) {
const url = `http://${host}:${port}/printer/print/start`;

const response = await this.apiClient.post(url, { filename } as any);
const response = await this.apiClient.post(url, { filename } as any, this.authHeaders(apiKey));

return response.data;
}

protected async rawCancelJob(host: string, port: string, apiKey: string) {
const url = `http://${host}:${port}/printer/print/cancel`;

const response = await this.apiClient.post(url, null as any);
const response = await this.apiClient.post(url, null as any, this.authHeaders(apiKey));

return response.data;
}
Expand All @@ -114,7 +126,7 @@ export class KlipperImplementation extends GenericPrinterImplementation {

const response = await this.apiClient.post(url, {
script: gcode
} as any);
} as any, this.authHeaders(apiKey));

return response.data;
}
Expand Down