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.

application/json

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

200

OK

application/json

Schema

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
]

Example (from schema)

{
  "createdBy": "string",
  "createdTs": 0,
  "enabled": true,
  "id": "string",
  "integrationId": "string",
  "integrationType": "email",
  "lastModifiedBy": "string",
  "lastModifiedTs": 0,
  "name": "string",
  "templateConfig": {}
}

429

Too Many Requests

4XX

default response

application/json

Schema

Schema

debugMessage string
message string
status string

Possible values: [100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED]

subErrors object[]
timestamp int64

Example (from schema)

{
  "debugMessage": "string",
  "message": "string",
  "status": "100 CONTINUE",
  "subErrors": [
    {}
  ],
  "timestamp": 0
}

Loading...