→
https://api.spectrocloud.com/v1alpha1/notifications/
summary:
Retrieves a list of notificationsParameters:
Name | Type | Description | Required |
---|---|---|---|
fields | string | Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name | no |
filters | string | Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource. | no |
orderBy | string | Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1 | no |
limit | integer | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
continue | string | continue token for the dataset | no |
200
An array of notification items
An array of notification items
{"items": [{"action": {"ack": "boolean","actionMessage": "string","actionType": "string","events": "object","isDone": "boolean","isInfo": "boolean","link": "string"},"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"relatedObject": {"kind": "string","name": "string","uid": "string"},"source": {"component": "string"},"type": "string"}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/notifications/events
summary:
Creates a notification event{"component": "string","digest": "string","message": "string","meta": "object","type": "string"}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1alpha1/notifications/{objectKind}/{objectUid}
summary:
Retrieves a list of notifications for the specified related objectParameters:
Name | Type | Description | Required |
---|---|---|---|
fields | string | Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name | no |
filters | string | Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource. | no |
orderBy | string | Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1 | no |
limit | integer | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
continue | string | continue token for the dataset | no |
Path parameters:
Name | Type | Description | Required |
---|---|---|---|
objectKind | string | yes | |
objectUid | string | yes | |
isDone | string | no |
200
An array of component event items
An array of component event items
{"items": [{"action": {"ack": "boolean","actionMessage": "string","actionType": "string","events": "object","isDone": "boolean","isInfo": "boolean","link": "string"},"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"relatedObject": {"kind": "string","name": "string","uid": "string"},"source": {"component": "string"},"type": "string"}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/notifications/{uid}/ack
summary:
Acknowledges the specified notificationPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/notifications/{uid}/done
summary:
Marks the specified notification's action as donePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
204
The resource was updated successfully
The resource was updated successfully