Returns a list of notifications for the specified related object

GET 
/v1/notifications/:objectKind/:objectUid

Returns a list of notifications for the specified related object

Request

Path Parameters

objectKind stringrequired

Possible values: [spectrocluster, clusterprofile, appdeployment]

Describes the related object kind for which notifications have to be fetched

objectUid stringrequired

Describes the related object uid for which notifications have to be fetched

Query Parameters

fields string

Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name

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.

orderBy string

Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1

limit int64

Default value: 50

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.

offset int64

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.

continue string

continue token to paginate the subsequent data items

isDone string

Describes a way to fetch "done" notifications

Responses

200

An array of component event items

application/json

Schema

Schema

items

object[]

required

Describe a list of generated notifications

Array [

action

object

Describes actions for the notification

ackboolean

Describes the acknowledgement status for the notification

actionMessagestring

Describes information related to notification action

actionTypestring

Possible values: [NotifyActionPacksUpdate, NotifyActionClusterProfileUpdate, NotifyActionPackRegistryUpdate, NotifyActionClusterUpdate, NotifyActionNone]

Describes action type for the notification. Possible Values [NotifyActionPacksUpdate, NotifyActionClusterProfileUpdate, NotifyActionPackRegistryUpdate, NotifyActionClusterUpdate, NotifyActionNone]

events

object

Describes the events happened for the notifications

property name*

object

property name*string

isDoneboolean

Describes the "Done" status for the notification

isInfoboolean

Describes the notification as a information

linkstring

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource.

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

relatedObject

object

Object for which the resource is related

kindstring

Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

namestring

uidstring

source

object

Describes origin info for the notification

componentstring

Describes component where notification originated

typestring

Possible values: [NotificationPackUpdate, NotificationPackRegistryUpdate, NotificationNone]

Describes type of notification. Possible values [NotificationPackUpdate, NotificationPackRegistryUpdate, NotificationNone]

]

listmeta

object

ListMeta describes metadata for the resource listing

continuestring

Next token for the pagination. Next token is equal to empty string indicates end of result set.

countinteger

Total count of the resources which might change during pagination based on the resources addition or deletion

limitinteger

Number of records feteched

offsetinteger

The next offset for the pagination. Starting index for which next request will be placed.

Example (from schema)

{
  "items": [
    {
      "action": {
        "ack": true,
        "actionMessage": "string",
        "actionType": "NotifyActionPacksUpdate",
        "events": {},
        "isDone": true,
        "isInfo": true,
        "link": "string"
      },
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-04-16T17:49:01.131Z",
        "deletionTimestamp": "2024-04-16T17:49:01.131Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-04-16T17:49:01.131Z",
        "name": "string",
        "uid": "string"
      },
      "relatedObject": {
        "kind": "spectrocluster",
        "name": "string",
        "uid": "string"
      },
      "source": {
        "component": "string"
      },
      "type": "NotificationPackUpdate"
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

Loading...