Events

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

summary:
Retrieves a list of component events
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters 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
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit 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
offsetintegeroffset 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
continuestringcontinue token to paginate the subsequent data itemsno
200
An array of component events items
{
"items": [
{
"involvedObject": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"message": "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"
},
"reason": "string",
"relatedObject": {
"kind": "string",
"name": "string",
"uid": "string"
},
"severity": "string",
"source": {
"component": "string",
"host": "string"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}

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

summary:
Creates a commponent event
{
"involvedObject": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"message": "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"
},
"reason": "string",
"relatedObject": {
"kind": "string",
"name": "string",
"uid": "string"
},
"severity": "string",
"source": {
"component": "string",
"host": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/events/components/bulk

summary:
Creates the component events in bulk
{
"items": {
"involvedObject": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"message": "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"
},
"reason": "string",
"relatedObject": {
"kind": "string",
"name": "string",
"uid": "string"
},
"severity": "string",
"source": {
"component": "string",
"host": "string"
}
}
}
201
Created successfully
{
"items": {
"uid": "string"
}
}

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

summary:
Retrieves a list of components events for the specified related object
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters 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
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit 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
offsetintegeroffset 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
continuestringcontinue token to paginate the subsequent data itemsno
Path parameters:
NameTypeDescriptionRequired
objectKindstringyes
objectUidstringyes
200
An array of component event items
{
"items": [
{
"involvedObject": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"message": "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"
},
"reason": "string",
"relatedObject": {
"kind": "string",
"name": "string",
"uid": "string"
},
"severity": "string",
"source": {
"component": "string",
"host": "string"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}

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

summary:
Delete all the components events for the specified related object
Path parameters:
NameTypeDescriptionRequired
objectKindstringyes
objectUidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/events/{eventUid}/components/{objectKind}/{objectUid}/context

summary:
Retrieves a list of components events for the given related object for given window period
Path parameters:
NameTypeDescriptionRequired
eventUidstringyes
objectKindstringyes
objectUidstringyes
windowPeriodintegerwindow period in minutes, will provide before & after events of window period durationno
200
An array of component event items
{
"items": [
{
"involvedObject": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"message": "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"
},
"reason": "string",
"relatedObject": {
"kind": "string",
"name": "string",
"uid": "string"
},
"severity": "string",
"source": {
"component": "string",
"host": "string"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}