@@ -17295,6 +17295,102 @@ components:
1729517295 - score
1729617296 - severity
1729717297 type: object
17298+ Email:
17299+ description: On-Call User Email.
17300+ example:
17301+ data:
17302+ attributes:
17303+ active: true
17304+ address: john.doe@datadoghq.com
17305+ alias: ''
17306+ formats:
17307+ - html
17308+ id: 45cd9fe5-dd96-42ad-83de-2242ea9f6efd
17309+ type: emails
17310+ properties:
17311+ data:
17312+ $ref: '#/components/schemas/EmailData'
17313+ type: object
17314+ EmailAttributes:
17315+ description: Attributes for an on-call email.
17316+ properties:
17317+ active:
17318+ description: Whether the email is currently active.
17319+ type: boolean
17320+ address:
17321+ description: Email address.
17322+ type: string
17323+ alias:
17324+ description: Optional display alias for the email.
17325+ type: string
17326+ formats:
17327+ description: Preferred content formats for notifications.
17328+ items:
17329+ $ref: '#/components/schemas/EmailFormatType'
17330+ type: array
17331+ type: object
17332+ EmailCreateRequest:
17333+ description: Request body for creating an On-Call email notification channel.
17334+ example:
17335+ data:
17336+ attributes:
17337+ active: true
17338+ address: john.doe@datadoghq.com
17339+ alias: ''
17340+ formats:
17341+ - html
17342+ type: emails
17343+ properties:
17344+ data:
17345+ $ref: '#/components/schemas/EmailData'
17346+ type: object
17347+ EmailData:
17348+ description: Data for an on-call email resource.
17349+ properties:
17350+ attributes:
17351+ $ref: '#/components/schemas/EmailAttributes'
17352+ id:
17353+ description: The email's unique identifier.
17354+ type: string
17355+ type:
17356+ $ref: '#/components/schemas/EmailType'
17357+ required:
17358+ - type
17359+ type: object
17360+ EmailFormatType:
17361+ description: Specifies the format of the e-mail that is sent for On-Call notifications
17362+ enum:
17363+ - html
17364+ - text
17365+ example: html
17366+ type: string
17367+ x-enum-varnames:
17368+ - HTML
17369+ - TEXT
17370+ EmailType:
17371+ default: emails
17372+ description: Indicates that the resource is of type 'emails'.
17373+ enum:
17374+ - emails
17375+ example: emails
17376+ type: string
17377+ x-enum-varnames:
17378+ - EMAILS
17379+ EmailUpdateRequest:
17380+ description: Request body for updating an On-Call email notification channel.
17381+ example:
17382+ data:
17383+ attributes:
17384+ active: true
17385+ address: john.doe@datadoghq.com
17386+ alias: ''
17387+ formats:
17388+ - html
17389+ type: emails
17390+ properties:
17391+ data:
17392+ $ref: '#/components/schemas/EmailData'
17393+ type: object
1729817394 Enabled:
1729917395 description: Field used to enable or disable the rule.
1730017396 example: true
@@ -71906,6 +72002,193 @@ paths:
7190672002 operator: AND
7190772003 permissions:
7190872004 - on_call_write
72005+ /api/v2/on-call/users/{user_id}/notification-channels/emails:
72006+ post:
72007+ description: Create a new email notification channel for an on-call user
72008+ operationId: CreateUserEmailNotificationChannel
72009+ parameters:
72010+ - description: The user ID
72011+ in: path
72012+ name: user_id
72013+ required: true
72014+ schema:
72015+ example: 00000000-0000-0000-0000-000000000000
72016+ type: string
72017+ requestBody:
72018+ content:
72019+ application/json:
72020+ schema:
72021+ $ref: '#/components/schemas/EmailCreateRequest'
72022+ required: true
72023+ responses:
72024+ '201':
72025+ content:
72026+ application/json:
72027+ schema:
72028+ $ref: '#/components/schemas/Email'
72029+ description: Created
72030+ '400':
72031+ $ref: '#/components/responses/BadRequestResponse'
72032+ '401':
72033+ $ref: '#/components/responses/UnauthorizedResponse'
72034+ '403':
72035+ $ref: '#/components/responses/ForbiddenResponse'
72036+ '404':
72037+ $ref: '#/components/responses/NotFoundResponse'
72038+ '429':
72039+ $ref: '#/components/responses/TooManyRequestsResponse'
72040+ security:
72041+ - apiKeyAuth: []
72042+ appKeyAuth: []
72043+ - AuthZ: []
72044+ summary: Create an On-Call email for a user
72045+ tags:
72046+ - On-Call
72047+ x-permission:
72048+ operator: AND
72049+ permissions:
72050+ - on_call_admin
72051+ /api/v2/on-call/users/{user_id}/notification-channels/emails/{email_id}:
72052+ delete:
72053+ description: Delete an email notification channel for an on-call user
72054+ operationId: DeleteUserEmailNotificationChannel
72055+ parameters:
72056+ - description: The user ID
72057+ in: path
72058+ name: user_id
72059+ required: true
72060+ schema:
72061+ example: 00000000-0000-0000-0000-000000000000
72062+ type: string
72063+ - description: The email ID
72064+ in: path
72065+ name: email_id
72066+ required: true
72067+ schema:
72068+ example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
72069+ type: string
72070+ responses:
72071+ '204':
72072+ description: No Content
72073+ '400':
72074+ $ref: '#/components/responses/BadRequestResponse'
72075+ '401':
72076+ $ref: '#/components/responses/UnauthorizedResponse'
72077+ '403':
72078+ $ref: '#/components/responses/ForbiddenResponse'
72079+ '404':
72080+ $ref: '#/components/responses/NotFoundResponse'
72081+ '429':
72082+ $ref: '#/components/responses/TooManyRequestsResponse'
72083+ security:
72084+ - apiKeyAuth: []
72085+ appKeyAuth: []
72086+ - AuthZ: []
72087+ summary: Delete an On-Call email for a user
72088+ tags:
72089+ - On-Call
72090+ x-permission:
72091+ operator: AND
72092+ permissions:
72093+ - on_call_admin
72094+ get:
72095+ description: Get an email notification channel for an on-call user
72096+ operationId: GetUserEmailNotificationChannel
72097+ parameters:
72098+ - description: The user ID
72099+ in: path
72100+ name: user_id
72101+ required: true
72102+ schema:
72103+ example: 00000000-0000-0000-0000-000000000000
72104+ type: string
72105+ - description: The email ID
72106+ in: path
72107+ name: email_id
72108+ required: true
72109+ schema:
72110+ example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
72111+ type: string
72112+ responses:
72113+ '200':
72114+ content:
72115+ application/json:
72116+ schema:
72117+ $ref: '#/components/schemas/Email'
72118+ description: OK
72119+ '400':
72120+ $ref: '#/components/responses/BadRequestResponse'
72121+ '401':
72122+ $ref: '#/components/responses/UnauthorizedResponse'
72123+ '403':
72124+ $ref: '#/components/responses/ForbiddenResponse'
72125+ '404':
72126+ $ref: '#/components/responses/NotFoundResponse'
72127+ '429':
72128+ $ref: '#/components/responses/TooManyRequestsResponse'
72129+ security:
72130+ - apiKeyAuth: []
72131+ appKeyAuth: []
72132+ - AuthZ: []
72133+ summary: Get an On-Call email for a user
72134+ tags:
72135+ - On-Call
72136+ x-permission:
72137+ operator: AND
72138+ permissions:
72139+ - on_call_admin
72140+ put:
72141+ description: Update an email notification channel for an on-call user
72142+ operationId: UpdateUserEmailNotificationChannel
72143+ parameters:
72144+ - description: The user ID
72145+ in: path
72146+ name: user_id
72147+ required: true
72148+ schema:
72149+ example: 00000000-0000-0000-0000-000000000000
72150+ type: string
72151+ - description: The email ID
72152+ in: path
72153+ name: email_id
72154+ required: true
72155+ schema:
72156+ example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
72157+ type: string
72158+ requestBody:
72159+ content:
72160+ application/json:
72161+ schema:
72162+ $ref: '#/components/schemas/EmailUpdateRequest'
72163+ required: true
72164+ responses:
72165+ '200':
72166+ content:
72167+ application/json:
72168+ schema:
72169+ $ref: '#/components/schemas/Email'
72170+ description: OK
72171+ '400':
72172+ $ref: '#/components/responses/BadRequestResponse'
72173+ '401':
72174+ $ref: '#/components/responses/UnauthorizedResponse'
72175+ '403':
72176+ $ref: '#/components/responses/ForbiddenResponse'
72177+ '404':
72178+ $ref: '#/components/responses/NotFoundResponse'
72179+ '429':
72180+ $ref: '#/components/responses/TooManyRequestsResponse'
72181+ security:
72182+ - apiKeyAuth: []
72183+ appKeyAuth: []
72184+ - AuthZ: []
72185+ summary: Update an On-Call email for a user
72186+ tags:
72187+ - On-Call
72188+ x-permission:
72189+ operator: AND
72190+ permissions:
72191+ - on_call_admin
7190972192 /api/v2/org_configs:
7191072193 get:
7191172194 description: Returns all Org Configs (name, description, and value).
0 commit comments