How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dokploy notification API

The notification API from Dokploy — 41 operation(s) for notification.

Dokploy notification API is one of 48 APIs that Dokploy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and rate-limit docs.

This API exposes 41 operations across 41 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://your-dokploy-instance.com/api.

41 operations 41 paths 5 schemas 3 GET38 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://your-dokploy-instance.com/api
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Dokploy notification API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKey). By default, every request must be authenticated.

  • apiKey — API key authentication. Generate an API key from your Dokploy dashboard under Settings API Keys.

Paths & Operations 41

Across 41 paths, the API surfaces 41 operations — 3 GET, 38 POST. Each is listed below with its method, path, parameters, and response codes.

notification 41
POST
/notification.createSlack
notification-createSlack body → 200400401403500
POST
/notification.updateSlack
notification-updateSlack body → 200400401403500
POST
/notification.testSlackConnection
notification-testSlackConnection body → 200400401403500
POST
/notification.createTelegram
notification-createTelegram body → 200400401403500
POST
/notification.updateTelegram
notification-updateTelegram body → 200400401403500
POST
/notification.testTelegramConnection
notification-testTelegramConnection body → 200400401403500
POST
/notification.createDiscord
notification-createDiscord body → 200400401403500
POST
/notification.updateDiscord
notification-updateDiscord body → 200400401403500
POST
/notification.testDiscordConnection
notification-testDiscordConnection body → 200400401403500
POST
/notification.createEmail
notification-createEmail body → 200400401403500
POST
/notification.updateEmail
notification-updateEmail body → 200400401403500
POST
/notification.testEmailConnection
notification-testEmailConnection body → 200400401403500
POST
/notification.createResend
notification-createResend body → 200400401403500
POST
/notification.updateResend
notification-updateResend body → 200400401403500
POST
/notification.testResendConnection
notification-testResendConnection body → 200400401403500
POST
/notification.remove
notification-remove body → 200400401403500
GET
/notification.one
notification-one 1 param → 200400401403404500
GET
/notification.all
notification-all → 200400401403404500
POST
/notification.receiveNotification
notification-receiveNotification body → 200400401403500
POST
/notification.createGotify
notification-createGotify body → 200400401403500
POST
/notification.updateGotify
notification-updateGotify body → 200400401403500
POST
/notification.testGotifyConnection
notification-testGotifyConnection body → 200400401403500
POST
/notification.createNtfy
notification-createNtfy body → 200400401403500
POST
/notification.updateNtfy
notification-updateNtfy body → 200400401403500
POST
/notification.testNtfyConnection
notification-testNtfyConnection body → 200400401403500
POST
/notification.createMattermost
notification-createMattermost body → 200400401403500
POST
/notification.updateMattermost
notification-updateMattermost body → 200400401403500
POST
/notification.testMattermostConnection
notification-testMattermostConnection body → 200400401403500
POST
/notification.createCustom
notification-createCustom body → 200400401403500
POST
/notification.updateCustom
notification-updateCustom body → 200400401403500
POST
/notification.testCustomConnection
notification-testCustomConnection body → 200400401403500
POST
/notification.createLark
notification-createLark body → 200400401403500
POST
/notification.updateLark
notification-updateLark body → 200400401403500
POST
/notification.testLarkConnection
notification-testLarkConnection body → 200400401403500
POST
/notification.createTeams
notification-createTeams body → 200400401403500
POST
/notification.updateTeams
notification-updateTeams body → 200400401403500
POST
/notification.testTeamsConnection
notification-testTeamsConnection body → 200400401403500
POST
/notification.createPushover
notification-createPushover body → 200400401403500
POST
/notification.updatePushover
notification-updatePushover body → 200400401403500
POST
/notification.testPushoverConnection
notification-testPushoverConnection body → 200400401403500
GET
/notification.getEmailProviders
notification-getEmailProviders → 200400401403404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are error.BAD_REQUEST (3 properties), error.UNAUTHORIZED (3 properties), error.FORBIDDEN (3 properties), error.INTERNAL_SERVER_ERROR (3 properties). Each schema is shown below with its type and property counts.

error.NOT_FOUND
object
The error information
3 properties 2 required
error.INTERNAL_SERVER_ERROR
object
The error information
3 properties 2 required
error.FORBIDDEN
object
The error information
3 properties 2 required
error.UNAUTHORIZED
object
The error information
3 properties 2 required
error.BAD_REQUEST
object
The error information
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dokploy-notification-api-openapi.yml Raw ↑

Other APIs Dokploy publishes across the network.

Dokploy admin API
Dokploy ai API
Dokploy application API
Dokploy auditLog API
Dokploy backup API
Dokploy bitbucket API
Dokploy certificates API
Dokploy cluster API
Dokploy compose API
Dokploy customRole API
Dokploy deployment API
Dokploy destination API
Where this information came from

This is an independent, third-party profile of Dokploy notification API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.