Jump to

• Request
• Response

Update a Notification Profile by ID

put

/api/notification/Profiles/{id}

Updates the properties of the specified notification profile.

Request

Path Parameters

• id(required): integer(int32)
  The notification profile ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BackupEmailPass: string
  Backup Email Password. If not defined, the Backup value will be the same as the corresponding Primary value.

  Example: password
• BackupEmailPort: integer
  Backup Email Port. If not defined, the Backup value will be the same as the corresponding Primary value.

  Example: 25
• BackupEmailServer: string
  Backup Email Server. If not defined, the Backup value will be the same as the corresponding Primary value.

  Example: backup.server.com
• BackupEmailTypeID: integer
  Backup Email Type ID. If not defined, the Backup value will be the same as the corresponding Primary value.

  Example: 1
• BackupEmailUser: string
  Backup Email User. If not defined, the Backup value will be the same as the corresponding Primary value.

  Example: [e-mail]
• ConnectionSecurity: integer
  Email Connection Security Flag. If ProfileTypeID is 1 (Email), ConnectionSecurity is required. Allowed Values: - 0 => Plaintext/None - 1 => SSL (Secure on Connect) - 2 => TLS (Negotiated)

  Example: 0
• PrimaryEmailPass: string
  Primary Email Password. If ProfileTypeID is 1 (Email), PrimaryEmailPass is required.

  Example: xyzABC123@
• PrimaryEmailPort: integer
  Primary Email Port. If ProfileTypeID is 1 (Email), PrimaryEmailPort is required.

  Example: 25
• PrimaryEmailServer: string
  Primary Email Server. If ProfileTypeID is 1 (Email), PrimaryEmailServer is required.

  Example: primary.server.com
• PrimaryEmailTypeID: integer
  Primary Email Type ID. If ProfileTypeID is 1 (Email), PrimaryEmailTypeID is required.

  Example: 1
• PrimaryEmailUser: string
  Primary Email User. If ProfileTypeID is 1 (Email), PrimaryEmailUser is required.

  Example: [e-mail]
• ProfileDescription: string
  Profile Description

  Example: This is the Generic Unified Assurance Profile for Email
• ProfileName: string
  The notification profile name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: Generic Email
• ProfileTypeID: integer
  Profile Type ID Allowed values: - 1 => Email - 2 => Syslog - 3 => Trap

  Example: 1
• ProfileTypeName: string
  Profile Type Name Allowed values: - Email - Syslog - Trap

  Example: Email
• SSLVerify: boolean
  Email SSL Verification indicator. If ProfileTypeID is 1 (Email), SSLVerify is required.

  Example: 1
• Timeout: integer
  Email Connection Timeout. If ProfileTypeID is 1 (Email), Timeout is required.

  Example: 30

{
    "properties":{
        "ProfileTypeID":{
            "description":"Profile Type ID\n\nAllowed values:\n- 1 => Email\n- 2 => Syslog\n- 3 => Trap",
            "type":"integer",
            "example":1
        },
        "ProfileTypeName":{
            "description":"Profile Type Name\n\nAllowed values:\n- Email\n- Syslog\n- Trap",
            "type":"string",
            "example":"Email"
        },
        "ProfileName":{
            "description":"The notification profile name.\n <br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Generic Email"
        },
        "ProfileDescription":{
            "description":"Profile Description",
            "type":"string",
            "example":"This is the Generic Unified Assurance Profile for Email"
        },
        "PrimaryEmailServer":{
            "description":"Primary Email Server. If ProfileTypeID is 1 (Email), PrimaryEmailServer is required.",
            "type":"string",
            "example":"primary.server.com"
        },
        "PrimaryEmailPort":{
            "description":"Primary Email Port. If ProfileTypeID is 1 (Email), PrimaryEmailPort is required.",
            "type":"integer",
            "example":25
        },
        "PrimaryEmailTypeID":{
            "description":"Primary Email Type ID. If ProfileTypeID is 1 (Email), PrimaryEmailTypeID is required.",
            "type":"integer",
            "example":1
        },
        "PrimaryEmailUser":{
            "description":"Primary Email User. If ProfileTypeID is 1 (Email), PrimaryEmailUser is required.",
            "type":"string",
            "example":"[e-mail]"
        },
        "PrimaryEmailPass":{
            "description":"Primary Email Password. If ProfileTypeID is 1 (Email), PrimaryEmailPass is required.",
            "type":"string",
            "example":"xyzABC123@"
        },
        "BackupEmailServer":{
            "description":"Backup Email Server. If not defined, the Backup value will be the same as the corresponding Primary value.",
            "type":"string",
            "example":"backup.server.com"
        },
        "BackupEmailPort":{
            "description":"Backup Email Port. If not defined, the Backup value will be the same as the corresponding Primary value.",
            "type":"integer",
            "example":25
        },
        "BackupEmailTypeID":{
            "description":"Backup Email Type ID. If not defined, the Backup value will be the same as the corresponding Primary value.",
            "type":"integer",
            "example":1
        },
        "BackupEmailUser":{
            "description":"Backup Email User. If not defined, the Backup value will be the same as the corresponding Primary value.",
            "type":"string",
            "example":"[e-mail]"
        },
        "BackupEmailPass":{
            "description":"Backup Email Password. If not defined, the Backup value will be the same as the corresponding Primary value.",
            "type":"string",
            "example":"password"
        },
        "ConnectionSecurity":{
            "description":"Email Connection Security Flag. If ProfileTypeID is 1 (Email), ConnectionSecurity is required.\n\nAllowed Values:\n- 0 => Plaintext/None\n- 1 => SSL (Secure on Connect)\n- 2 => TLS (Negotiated)",
            "type":"integer",
            "example":0
        },
        "SSLVerify":{
            "description":"Email SSL Verification indicator. If ProfileTypeID is 1 (Email), SSLVerify is required.",
            "type":"boolean",
            "example":"1"
        },
        "Timeout":{
            "description":"Email Connection Timeout. If ProfileTypeID is 1 (Email), Timeout is required.",
            "type":"integer",
            "example":30
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/notificationProfilesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/notificationProfilesRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object notificationProfilesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/notificationProfilesRead"
    }
}

Nested Schema : notificationProfilesRead

Type: object

Show Source

• BackupEmailPass: string
  Password for the Backup Email Server user

  Example: password
• BackupEmailPort: integer
  Backup Email Server port

  Example: 25
• BackupEmailServer: string
  FQDN of Backup Email Server

  Example: backup.server.com
• BackupEmailTypeID: integer
  Backup Email Type ID

  Example: 1
• BackupEmailUser: string
  User for the Backup Email Server

  Example: [e-mail]
• ConnectionSecurity: integer
  Email Connection Security Flag Allowed Values: - 0 => Plaintext/None - 1 => SSL (Secure on Connect) - 2 => TLS (Negotiated)

  Example: 0
• PrimaryEmailPass: string
  Password for the Primary Email Server user

  Example: xyzABC123@
• PrimaryEmailPort: integer
  Primary Email Server port

  Example: 25
• PrimaryEmailServer: string
  FQDN of Primary Email Server

  Example: primary.server.com
• PrimaryEmailTypeID: integer
  Primary Email Type ID

  Example: 1
• PrimaryEmailUser: string
  User for the Primary Email Server

  Example: [e-mail]
• ProfileDescription: string
  Profile Description

  Example: This is the Generic Unified Assurance Profile for Email
• ProfileID: integer
  Profile ID

  Example: 1
• ProfileName: string
  Name for the Notification Profile.

  Example: Generic Email
• ProfileTypeID: integer
  ID of Notification Profile Type. Possible values: - 1 => Email - 2 => Syslog - 3 => SNMP Trap

  Example: 1
• ProfileTypeName: string
  Name of Notification Profile Type.

  Example: Email
• SSLVerify: boolean
  Flag to indicate whether SSL certificate authentication is needed

  Example: 1
• SyslogPort: integer
  Syslog server port

  Example: 80
• SyslogServers: string
  FQDN of Syslog Servers. If more than one server, the value is presented in comma separated list.

  Example:
• Timeout: integer
  Timeout (in seconds) for Email server connection

  Example: 30
• TrapPort: integer
  Trap Servers port

  Example:
• TrapServers: string
  FQDN of Trap Servers. If more than one server, the value is presented in comma separated list.

  Example:

{
    "properties":{
        "ProfileID":{
            "description":"Profile ID",
            "type":"integer",
            "example":1
        },
        "ProfileTypeID":{
            "description":"ID of Notification Profile Type. \n\nPossible values: \n- 1 => Email\n- 2 => Syslog\n- 3 => SNMP Trap",
            "type":"integer",
            "example":1
        },
        "ProfileTypeName":{
            "description":"Name of Notification Profile Type.",
            "type":"string",
            "example":"Email"
        },
        "ProfileName":{
            "description":"Name for the Notification Profile.",
            "type":"string",
            "example":"Generic Email"
        },
        "ProfileDescription":{
            "description":"Profile Description",
            "type":"string",
            "example":"This is the Generic Unified Assurance Profile for Email"
        },
        "PrimaryEmailServer":{
            "description":"FQDN of Primary Email Server",
            "type":"string",
            "example":"primary.server.com"
        },
        "PrimaryEmailPort":{
            "description":"Primary Email Server port",
            "type":"integer",
            "example":25
        },
        "PrimaryEmailTypeID":{
            "description":"Primary Email Type ID",
            "type":"integer",
            "example":1
        },
        "PrimaryEmailUser":{
            "description":"User for the Primary Email Server",
            "type":"string",
            "example":"[e-mail]"
        },
        "PrimaryEmailPass":{
            "description":"Password for the Primary Email Server user",
            "type":"string",
            "example":"xyzABC123@"
        },
        "BackupEmailServer":{
            "description":"FQDN of Backup Email Server",
            "type":"string",
            "example":"backup.server.com"
        },
        "BackupEmailPort":{
            "description":"Backup Email Server port",
            "type":"integer",
            "example":25
        },
        "BackupEmailTypeID":{
            "description":"Backup Email Type ID",
            "type":"integer",
            "example":1
        },
        "BackupEmailUser":{
            "description":"User for the Backup Email Server",
            "type":"string",
            "example":"[e-mail]"
        },
        "BackupEmailPass":{
            "description":"Password for the Backup Email Server user",
            "type":"string",
            "example":"password"
        },
        "ConnectionSecurity":{
            "description":"Email Connection Security Flag\n\nAllowed Values:\n- 0 => Plaintext/None\n- 1 => SSL (Secure on Connect)\n- 2 => TLS (Negotiated)",
            "type":"integer",
            "example":0
        },
        "SSLVerify":{
            "description":"Flag to indicate whether SSL certificate authentication is needed",
            "type":"boolean",
            "example":"1"
        },
        "Timeout":{
            "description":"Timeout (in seconds) for Email server connection",
            "type":"integer",
            "example":30
        },
        "SyslogServers":{
            "description":"FQDN of Syslog Servers. If more than one server, the value is presented in comma separated list.",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "SyslogPort":{
            "description":"Syslog server port",
            "type":"integer",
            "example":80,
            "nullable":true
        },
        "TrapServers":{
            "description":"FQDN of Trap Servers. If more than one server, the value is presented in comma separated list.",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "TrapPort":{
            "description":"Trap Servers port",
            "type":"integer",
            "example":"",
            "nullable":true
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top