Events

→

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

summary:

Retrieves a list of component events

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. 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

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

{
  "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",
        "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"
  }
}

→

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

summary:

Creates a commponent event

Body

{
  "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",
    "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"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Creates the component events in bulk

Body

{
  "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",
      "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"
    }
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "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:

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

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

{
  "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",
        "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"
  }
}

→

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

summary:

Delete all the components events for the specified related object

Path parameters:

Name	Type	Description	Required
objectKind	string		yes
objectUid	string		yes

HTTP code: 204
Description: 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:

Name	Type	Description	Required
eventUid	string		yes
objectKind	string		yes
objectUid	string		yes
windowPeriod	integer	window period in minutes, will provide before & after events of window period duration	no

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

{
  "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",
        "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"
  }
}

Edit on GitHub