Filters

→

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

summary:

Returns a list of Filters

Parameters:

Name	Type	Description	Required
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 filters
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "filterType": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/filters/metadata

summary:

Returns a list of Filters metadata

Parameters:

Name	Type	Description	Required
filterType	string	filterType can be - [tag, meta, resource]	no

HTTP code: 200
Description: An array of filters
Response body:

{
  "items": [
    {
      "filterType": "string",
      "name": "string",
      "uid": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/filters/tag

summary:

Creates a Tag filter

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "filterGroup": {
      "conjunction": "string",
      "filters": [
        {
          "key": "string",
          "negation": "boolean",
          "operator": "string",
          "values": [
            "string"
          ]
        }
      ]
    }
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/filters/tag/{uid}

summary:

Delete the specified Filter object

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/filters/tag/{uid}

summary:

Returns the specified Filter object

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: A Filter object
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "filterGroup": {
      "conjunction": "string",
      "filters": [
        {
          "key": "string",
          "negation": "boolean",
          "operator": "string",
          "values": [
            "string"
          ]
        }
      ]
    }
  }
}

→

https://api.spectrocloud.com/v1/filters/tag/{uid}

summary:

Updates a Tag filter

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "filterGroup": {
      "conjunction": "string",
      "filters": [
        {
          "key": "string",
          "negation": "boolean",
          "operator": "string",
          "values": [
            "string"
          ]
        }
      ]
    }
  }
}

HTTP code: 204
Description: The resource was updated successfully

Edit on GitHub