Notifications

→

https://api.spectrocloud.com/v1/notifications/

summary:

Retrieves a list of notifications

Parameters:

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. Default and maximum value of the limit is 50. 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
offset	integer	offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of notification items
Response body:

{
  "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",
        "lastModifiedTimestamp": "date-time",
        "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",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/notifications/events

summary:

Creates a notification event

Body

{
  "component": "string",
  "digest": "string",
  "message": "string",
  "meta": "object",
  "type": "string"
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/notifications/{objectKind}/{objectUid}

summary:

Retrieves a list of notifications for the specified related object

Parameters:

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. Default and maximum value of the limit is 50. 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
offset	integer	offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.	no
continue	string	continue token to paginate the subsequent data items	no

Path parameters:

Name	Type	Required
objectKind	string	yes
objectUid	string	yes
isDone	string	no

HTTP code: 200
Description: An array of component event items
Response body:

{
  "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",
        "lastModifiedTimestamp": "date-time",
        "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",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/notifications/{uid}/ack

summary:

Acknowledges the specified notification

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/notifications/{uid}/done

summary:

Marks the specified notification's action as done

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was updated successfully

Edit on GitHub