The notification REST endpoint object represents settings of particular REST API endpoint.
References to notification:rest:endpoint are object references.
The name part of the notification:rest:endpoint object reference has the following components:
- The name of an endpoint.
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): name, outbound_member_type, uri.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| outbound_member_type | |
| uri |
The client certificate subject of a notification REST endpoint.
Type
String.
Search
The field is not available for search.
Notes
The client_certificate_subject cannot be updated.
client_certificate_subject cannot be written.
The token returned by the uploadinit function call in object fileop for a notification REST endpoit client certificate.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
client_certificate_token is not readable.
The timestamp when client certificate for a notification REST endpoint was created.
Type
Timestamp.
Search
The field is not available for search.
Notes
The client_certificate_valid_from cannot be updated.
client_certificate_valid_from cannot be written.
The timestamp when client certificate for a notification REST endpoint expires.
Type
Timestamp.
Search
The field is not available for search.
Notes
The client_certificate_valid_to cannot be updated.
client_certificate_valid_to cannot be written.
The comment of a notification REST endpoint.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
The log level for a notification REST endpoint.
Type
String.
Create
The default value is WARNING.
Search
The field is available for search via
The name of a notification REST endpoint.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
The outbound member which will generate an event.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The outbound_member_type is part of the base object.
The list of members for outbound events.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
The password of the user that can log into a notification REST endpoint.
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
password is not readable.
The server certificate validation type.
Type
String.
Create
The default value is CA_CERT.
Search
The field is not available for search.
Determines if the sync process is disabled for a notification REST endpoint.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The notification REST template instance. The parameters of REST API endpoint template instance are prohibited to change.
Type
A/An Notification REST template instance struct.
Create
The default value is empty.
Search
The field is not available for search.
The timeout of session management (in seconds).
Type
Unsigned integer.
Create
The default value is 30.
Search
The field is not available for search.
The URI of a notification REST endpoint.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The uri is part of the base object.
The username of the user that can log into a notification REST endpoint.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
The vendor identifier.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Use this function to clear the outbound worker log for the endpoint.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
None
Output fields
error_message ( String. ) The error message.
overall_status ( String. Valid values are: “FAILED”, “SUCCESS” ) The overall status of clearing procedure.
Test connectivity to the REST API endpoint.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
None
Output fields
error_message ( String. ) The test connectivity failed error message.
overall_status ( String. Valid values are: “FAILED”, “SUCCESS” ) The overall status of connectivity test.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| client_certificate_subject | String | N | Y | N | N/A |
| client_certificate_token | String | N | N | N | N/A |
| client_certificate_valid_from | Timestamp | N | Y | N | N/A |
| client_certificate_valid_to | Timestamp | N | Y | N | N/A |
| comment | String | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| log_level | String | N | N | N | = |
| name | String | Y | N | Y | : = ~ |
| outbound_member_type | String | Y | N | Y | = |
| outbound_members | [String] | N | N | N | N/A |
| password | String | N | N | N | N/A |
| server_cert_validation | String | N | N | N | N/A |
| sync_disabled | Bool | N | N | N | N/A |
| template_instance | struct | N | N | N | N/A |
| timeout | Unsigned int | N | N | N | N/A |
| uri | String | Y | N | Y | : = ~ |
| username | String | N | N | N | N/A |
| vendor_identifier | String | N | N | N | : = ~ |
| wapi_user_name | String | N | N | N | N/A |
| wapi_user_password | String | N | N | N | N/A |
networkview : DHCP NetworkView object.
notification:rest:template : The notification REST template object.
