Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai NotificationChannels API

Notification Channels are the medium through which notifications are sent.

NVIDIA Run:ai NotificationChannels API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include NotificationChannels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 8 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://app.run.ai.

8 operations 4 paths 13 schemas 1 DELETE2 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Base URL
https://app.run.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai NotificationChannels API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

NotificationChannels 8

Notification Channels are the medium through which notifications are sent.

GET
/api/v1/notification-channels
Get supported Notification Channels
getNotificationChannels → 200401403404500501503
POST
/api/v1/notification-channels
Create configuration of notification channel
createNotificationChannelConfig body → 200400401403404409500501
POST
/api/v1/notification-channels/slack/create-app
Create Slack app
createSlackApp body → 200400401403404500501503
GET
/api/v1/notification-channels/{name}
Get configuration of notification channel
getNotificationChannelConfig 1 param → 200400401403404500501503
PATCH
/api/v1/notification-channels/{name}
Patch configuration of Notification Channel
patchNotificationChannelConfig 1 param body → 200400401403404500501503
PUT
/api/v1/notification-channels/{name}
Update configuration of Notification Channel
updateNotificationChannelConfig 1 param body → 200400401403404500501503
DELETE
/api/v1/notification-channels/{name}
Delete configuration of Notification Channel
deleteNotificationChannelConfig 1 param → 204400401403404500501503
POST
/api/v1/validate-notification-channel
Validate configuration of Notification Channel
validateNotificationChannel body → 200400401403404409500501

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are EmailNotificationChannelConfig (12 properties), Error (3 properties), SlackNotificationChannelConfig (3 properties), NotificationChannelForPatch (2 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties 2 required
EmailNotificationChannelConfig
object
12 properties
NotificationChannelForPatch
object
2 properties
NotificationChannelConfig
object
EmailAuthType
string
NotificationChannelType
string
CreateSlackAppRequestBody
object
1 property 1 required
NotificationChannel
object
2 required
NotificationChannelResponse
object
3 required
NotificationChannelForValidate
object
2 required
CreateSlackAppResponse
object
1 property 1 required
SlackNotificationChannelConfig
object
3 properties
NotificationChannelMeta
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-notificationchannels-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API
NVIDIA Run:ai Access rules API
NVIDIA Run:ai Administrator Command Line Interface API
NVIDIA Run:ai AI Applications API
NVIDIA Run:ai Applications API
NVIDIA Run:ai AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API