NotificationChannels

Notification Channels are the medium through which notifications are sent.

Get supported Notification Channels

get

Get supported Notification Channels

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Notification Channel types

applicatin/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/notification-channels

HTTPcURLJavaScriptPython

GET /api/v1/notification-channels HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "my-email",
    "type": "email"
  }
]

Create configuration of notification channel

post

Create configuration of notification channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

200

Notification Channel config created

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

409

The specified resource already exists

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/notification-channels

HTTPcURLJavaScriptPython

POST /api/v1/notification-channels HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "type": "email",
  "config": {
    "username": "[email protected]",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "[email protected]",
    "subject": "My subject"
  },
  "name": "text"
}

No content

Get configuration of notification channel

get

Get configuration of notification channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

namestringRequired

Notification Channel name

Responses

200

Notification channel config

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/notification-channels/{name}

HTTPcURLJavaScriptPython

GET /api/v1/notification-channels/{name} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "email",
  "config": {
    "username": "[email protected]",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "[email protected]",
    "subject": "My subject"
  },
  "name": "text"
}

Update configuration of Notification Channel

put

Update configuration of Notification Channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

namestringRequired

Notification Channel name

Body

application/json

Responses

200

Notification Channel config updated

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

put

/api/v1/notification-channels/{name}

HTTPcURLJavaScriptPython

PUT /api/v1/notification-channels/{name} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "type": "email",
  "config": {
    "username": "[email protected]",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "[email protected]",
    "subject": "My subject"
  },
  "name": "text"
}

No content

Delete configuration of Notification Channel

delete

Delete configuration of Notification Channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

namestringRequired

Notification Channel name

Responses

204

Notification Channel config deleted

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

delete

/api/v1/notification-channels/{name}

HTTPcURLJavaScriptPython

DELETE /api/v1/notification-channels/{name} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Patch configuration of Notification Channel

patch

Patch configuration of Notification Channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

namestringRequired

Notification Channel name

Body

application/json

typestring · enumOptionalDefault: emailPossible values:

Responses

200

Notification Channel config patched

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

patch

/api/v1/notification-channels/{name}

HTTPcURLJavaScriptPython

PATCH /api/v1/notification-channels/{name} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "type": "email",
  "config": {
    "username": "[email protected]",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "[email protected]",
    "subject": "My subject"
  }
}

No content

Validate configuration of Notification Channel

post

Validate configuration of Notification Channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

200

Notification Channel validity

application/json

ResponsebooleanExample: true

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

409

The specified resource already exists

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/validate-notification-channel

HTTPcURLJavaScriptPython

POST /api/v1/validate-notification-channel HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "type": "email",
  "config": {
    "username": "[email protected]",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "[email protected]",
    "subject": "My subject"
  }
}

true