LukeParke/Dokploy-ts-sdk

Fork 0

mirror of https://github.com/LukeHagar/Dokploy-ts-sdk.git synced 2025-12-06 12:27:48 +00:00

Files

History

Luke Hagar f7b542efbf initial commit

2025-09-26 02:33:10 +00:00

README.md

initial commit

2025-09-26 02:33:10 +00:00

README.md

Notification

(notification)

Overview

Available Operations

createSlack
updateSlack
testSlackConnection
createTelegram
updateTelegram
testTelegramConnection
createDiscord
updateDiscord
testDiscordConnection
createEmail
updateEmail
testEmailConnection
remove
getAll

createSlack

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.createSlack({
    appBuildError: true,
    databaseBackup: true,
    dokployRestart: false,
    name: "<value>",
    appDeploy: false,
    dockerCleanup: false,
    webhookUrl: "https://familiar-custody.name",
    channel: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationCreateSlack } from "dokploy/funcs/notificationCreateSlack.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationCreateSlack(dokploy, {
    appBuildError: true,
    databaseBackup: true,
    dokployRestart: false,
    name: "<value>",
    appDeploy: false,
    dockerCleanup: false,
    webhookUrl: "https://familiar-custody.name",
    channel: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationCreateSlack failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationCreateSlackRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

updateSlack

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.updateSlack({
    notificationId: "<id>",
    slackId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationUpdateSlack } from "dokploy/funcs/notificationUpdateSlack.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationUpdateSlack(dokploy, {
    notificationId: "<id>",
    slackId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationUpdateSlack failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationUpdateSlackRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

testSlackConnection

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.testSlackConnection({
    webhookUrl: "https://pointed-institute.com",
    channel: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationTestSlackConnection } from "dokploy/funcs/notificationTestSlackConnection.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationTestSlackConnection(dokploy, {
    webhookUrl: "https://pointed-institute.com",
    channel: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationTestSlackConnection failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationTestSlackConnectionRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

createTelegram

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.createTelegram({
    appBuildError: false,
    databaseBackup: true,
    dokployRestart: false,
    name: "<value>",
    appDeploy: true,
    dockerCleanup: true,
    botToken: "<value>",
    chatId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationCreateTelegram } from "dokploy/funcs/notificationCreateTelegram.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationCreateTelegram(dokploy, {
    appBuildError: false,
    databaseBackup: true,
    dokployRestart: false,
    name: "<value>",
    appDeploy: true,
    dockerCleanup: true,
    botToken: "<value>",
    chatId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationCreateTelegram failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationCreateTelegramRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

updateTelegram

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.updateTelegram({
    notificationId: "<id>",
    telegramId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationUpdateTelegram } from "dokploy/funcs/notificationUpdateTelegram.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationUpdateTelegram(dokploy, {
    notificationId: "<id>",
    telegramId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationUpdateTelegram failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationUpdateTelegramRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

testTelegramConnection

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.testTelegramConnection({
    botToken: "<value>",
    chatId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationTestTelegramConnection } from "dokploy/funcs/notificationTestTelegramConnection.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationTestTelegramConnection(dokploy, {
    botToken: "<value>",
    chatId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationTestTelegramConnection failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationTestTelegramConnectionRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

createDiscord

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.createDiscord({
    appBuildError: false,
    databaseBackup: true,
    dokployRestart: false,
    name: "<value>",
    appDeploy: false,
    dockerCleanup: true,
    webhookUrl: "https://present-sport.net/",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationCreateDiscord } from "dokploy/funcs/notificationCreateDiscord.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationCreateDiscord(dokploy, {
    appBuildError: false,
    databaseBackup: true,
    dokployRestart: false,
    name: "<value>",
    appDeploy: false,
    dockerCleanup: true,
    webhookUrl: "https://present-sport.net/",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationCreateDiscord failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationCreateDiscordRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

updateDiscord

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.updateDiscord({
    notificationId: "<id>",
    discordId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationUpdateDiscord } from "dokploy/funcs/notificationUpdateDiscord.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationUpdateDiscord(dokploy, {
    notificationId: "<id>",
    discordId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationUpdateDiscord failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationUpdateDiscordRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

testDiscordConnection

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.testDiscordConnection({
    webhookUrl: "https://radiant-fireplace.net",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationTestDiscordConnection } from "dokploy/funcs/notificationTestDiscordConnection.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationTestDiscordConnection(dokploy, {
    webhookUrl: "https://radiant-fireplace.net",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationTestDiscordConnection failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationTestDiscordConnectionRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

createEmail

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.createEmail({
    appBuildError: false,
    databaseBackup: false,
    dokployRestart: true,
    name: "<value>",
    appDeploy: false,
    dockerCleanup: false,
    smtpServer: "<value>",
    smtpPort: 8149.3,
    username: "Krystal95",
    password: "LGAnX2vuZKQTVc9",
    fromAddress: "<value>",
    toAddresses: [],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationCreateEmail } from "dokploy/funcs/notificationCreateEmail.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationCreateEmail(dokploy, {
    appBuildError: false,
    databaseBackup: false,
    dokployRestart: true,
    name: "<value>",
    appDeploy: false,
    dockerCleanup: false,
    smtpServer: "<value>",
    smtpPort: 8149.3,
    username: "Krystal95",
    password: "LGAnX2vuZKQTVc9",
    fromAddress: "<value>",
    toAddresses: [],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationCreateEmail failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationCreateEmailRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

updateEmail

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.updateEmail({
    notificationId: "<id>",
    emailId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationUpdateEmail } from "dokploy/funcs/notificationUpdateEmail.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationUpdateEmail(dokploy, {
    notificationId: "<id>",
    emailId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationUpdateEmail failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationUpdateEmailRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

testEmailConnection

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.testEmailConnection({
    smtpServer: "<value>",
    smtpPort: 4799.46,
    username: "Rollin96",
    password: "xHtlQtIjbn2x0yV",
    toAddresses: [
      "<value 1>",
      "<value 2>",
    ],
    fromAddress: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationTestEmailConnection } from "dokploy/funcs/notificationTestEmailConnection.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationTestEmailConnection(dokploy, {
    smtpServer: "<value>",
    smtpPort: 4799.46,
    username: "Rollin96",
    password: "xHtlQtIjbn2x0yV",
    toAddresses: [
      "<value 1>",
      "<value 2>",
    ],
    fromAddress: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationTestEmailConnection failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationTestEmailConnectionRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

remove

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.remove({
    notificationId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationRemove } from "dokploy/funcs/notificationRemove.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationRemove(dokploy, {
    notificationId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationRemove failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.NotificationRemoveRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

getAll

Example Usage

import { Dokploy } from "dokploy";

const dokploy = new Dokploy({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const result = await dokploy.notification.getAll();

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DokployCore } from "dokploy/core.js";
import { notificationGetAll } from "dokploy/funcs/notificationGetAll.js";

// Use `DokployCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dokploy = new DokployCore({
  authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "",
});

async function run() {
  const res = await notificationGetAll(dokploy);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("notificationGetAll failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ErrorT>

Errors

Error Type	Status Code	Content Type
errors.DokployDefaultError	4XX, 5XX	/

README.md Unescape Escape

Notification

Overview

Available Operations

createSlack

Example Usage

Standalone function

Parameters

Response

Errors

updateSlack

Example Usage

Standalone function

Parameters

Response

Errors

testSlackConnection

Example Usage

Standalone function

Parameters

Response

Errors

createTelegram

Example Usage

Standalone function

Parameters

Response

Errors

updateTelegram

Example Usage

Standalone function

Parameters

Response

Errors

testTelegramConnection

Example Usage

Standalone function

Parameters

Response

Errors

createDiscord

Example Usage

Standalone function

Parameters

Response

Errors

updateDiscord

Example Usage

Standalone function

Parameters

Response

Errors

testDiscordConnection

Example Usage

Standalone function

Parameters

Response

Errors

createEmail

Example Usage

Standalone function

Parameters

Response

Errors

updateEmail

Example Usage

Standalone function

Parameters

Response

Errors

testEmailConnection

Example Usage

Standalone function

Parameters

Response

Errors

remove

Example Usage

Standalone function

Parameters

README.md