Skip to main content

Add Template

POST 

/api/v1/tenant/:prismaId/template

Creates a notification template. The caller must have one of the following Prisma Cloud roles:

  • System Admin
  • Account and Cloud Provisioning Admin

Request

Path Parameters

    prismaId stringrequired

    Prisma ID. Your Prisma ID is available either from the response object of your API request to log in or from the licensing information in the Prisma Cloud console.

Body

required
    integrationId string

    Integration Id

    integrationType stringrequired

    Possible values: [email, jira, service_now]

    Integration type

    name stringrequired

    Possible values: >= 5 characters and <= 100 characters, Value must match regular expression ^[A-Za-z0-9](.){0,99}$

    Template name

    templateConfig objectrequired

    Template config

    property name* object[]

    Template configuration

  • Array [
  • aliasField string

    Alias field

    displayName string

    Display name

    fieldName string

    Field name

    maxLength int32

    Maximum length

    options object[]
  • Array [
  • id string

    Field option ID

    key string

    Field option key

    name string

    Field option name

  • ]
  • redlockMapping boolean

    true = Prisma Cloud will provide the field value for notification

    required boolean

    true = Required

    type string

    Possible values: [list, text, array, bool, integer]

    Type of field

    typeaheadUri string

    URL used to query suggestions for field value

    value string

    Field value

  • ]

Responses

OK

Schema
    createdBy string

    User who created the notification template

    createdTs int64

    Creation Unix timestamp in milliseconds

    enabled boolean

    true = Enabled

    id string

    Notification template ID

    integrationId string

    Integration ID

    integrationType stringrequired

    Possible values: [email, jira, service_now]

    Integration type

    lastModifiedBy string

    User who modified template last

    lastModifiedTs int64

    Modification Unix timestamp in milliseconds

    name stringrequired

    Name. Cannot include special characters ('<', '>', '!', '=', '\n', '\r'). Maximum length is 99.

    templateConfig object
    property name* object[]
  • Array [
  • aliasField string

    Alias field

    displayName string

    Display name

    fieldName string

    Field name

    maxLength int32

    Maximum length

    options object[]
  • Array [
  • id string

    Field option ID

    key string

    Field option key

    name string

    Field option name

  • ]
  • redlockMapping boolean

    true = Prisma Cloud will provide the field value for notification

    required boolean

    true = Required

    type string

    Possible values: [list, text, array, bool, integer]

    Type of field

    typeaheadUri string

    URL used to query suggestions for field value

    value string

    Field value

  • ]
Loading...