{
"opencollection": "1.0.0",
"info": {
"name": "CyCognito API V1 Reference Assets Issues API",
"version": "0.0.1"
},
"items": [
{
"info": {
"name": "Issues",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/issues",
"params": [
{
"name": "count",
"value": "",
"type": "query",
"description": "Defines the number of results to be retrieved. Defaults to 10 with a max limit of 1000."
},
{
"name": "advanced-search",
"value": "",
"type": "query",
"description": "Allows you to input raw CyQL in order to query assets, issues, or organizations. See our Advanced Search documentation for more details."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Sets the starting index for result retrieval, influenced by the `count` parameter. By default, `offset` is 0. Example: `offset` 3 with `count` 25 fetches results from index 75 to 99."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Specifies a search term for conducting a keyword-based search and retrieving data that matches your query."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma-separated list specifying the desired entity properties to appear in the response. For more information, view the response example and schema."
},
{
"name": "sort-by",
"value": "",
"type": "query",
"description": "Specifies the field by which the results should be sorted."
},
{
"name": "sort-order",
"value": "",
"type": "query",
"description": "Sorts the specified field in ascending or descending order."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieve a list of issues based on given filter criteria. If you are comparing search results with the CyCognito app, note that Predefined Filters are not applied to data queried via the API by default."
},
{
"info": {
"name": "Fetch issue details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/issues/issue/:issue_instance_id",
"params": [
{
"name": "issue_instance_id",
"value": "",
"type": "path",
"description": "Unique identifier for a specific issue occurrence on an asset. This is the `id` value from the response, excluding the `issue/` prefix."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Obtain details of a specific issue using its identifier."
},
{
"info": {
"name": "Update issue's investigation status",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/issues/issue/:issue_instance_id/investigation-status",
"params": [
{
"name": "issue_instance_id",
"value": "",
"type": "path",
"description": "Unique identifier for a specific issue occurrence on an asset. This is the `id` value from the response, excluding the `issue/` prefix."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Adjust the specified issue's investigation status:\n- **Investigated** – The issue has been investigated.\n- **Investigating** – The issue is currently undergoing investigation by someone in your team.\n- **Uninvestigated** – The issue has not been investigated yet."
},
{
"info": {
"name": "Add comments to issues",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/issues/actions/add/comment",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Allows you to add comments to multiple issues identified by their unique IDs. The comments are appended to the existing comment log and do not replace any existing content."
},
{
"info": {
"name": "Handle issue tags",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/issues/actions/:action/tags",
"params": [
{
"name": "action",
"value": "",
"type": "path",
"description": "Choose an action to apply to the tags on the specified entities: \n * **add** – Apply new tags in addition to the existing tags on the specified entities. \n * **remove** – Clears only the indicated tags from the specified entities. \n * **replace** – Replaces *all* of the current tags on *all* of the specified entities with the indicated tags. \n * **remove-all** – Clears *all* of the existing tags from the specified entities."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Add or remove custom tags from specified issues."
},
{
"info": {
"name": "Archive issues",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/issues/actions/archive",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Move issues to an archived state, distinguishing them from open and resolved issues."
},
{
"info": {
"name": "Snooze issues",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/issues/actions/snooze",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Snooze issues for a specified duration, hiding them from your open issues list until the snooze period expires. This enables automated lifecycle control from external workflows while maintaining accurate attack surface metrics."
},
{
"info": {
"name": "Search archived issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/archived-issues",
"params": [
{
"name": "count",
"value": "",
"type": "query",
"description": "Defines the number of results to be retrieved. Defaults to 10 with a max limit of 1000."
},
{
"name": "advanced-search",
"value": "",
"type": "query",
"description": "Allows you to input raw CyQL in order to query assets, issues, or organizations. See our Advanced Search documentation for more details."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Sets the starting index for result retrieval, influenced by the `count` parameter. By default, `offset` is 0. Example: `offset` 3 with `count` 25 fetches results from index 75 to 99."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Specifies a search term for conducting a keyword-based search and retrieving data that matches your query."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma-separated list specifying the desired entity properties to appear in the response. For more information, view the response example and schema."
},
{
"name": "sort-by",
"value": "",
"type": "query",
"description": "Specifies the field by which the results should be sorted."
},
{
"name": "sort-order",
"value": "",
"type": "query",
"description": "Sorts the specified field in ascending or descending order."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieve archived issues based on set criteria. If you are comparing search results with the CyCognito app, note that Predefined Filters are not applied to data queried via the API by default."
},
{
"info": {
"name": "Search resolved issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/resolved-issues",
"params": [
{
"name": "count",
"value": "",
"type": "query",
"description": "Defines the number of results to be retrieved. Defaults to 10 with a max limit of 1000."
},
{
"name": "advanced-search",
"value": "",
"type": "query",
"description": "Allows you to input raw CyQL in order to query assets, issues, or organizations. See our Advanced Search documentation for more details."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Sets the starting index for result retrieval, influenced by the `count` parameter. By default, `offset` is 0. Example: `offset` 3 with `count` 25 fetches results from index 75 to 99."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Specifies a search term for conducting a keyword-based search and retrieving data that matches your query."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma-separated list specifying the desired entity properties to appear in the response. For more information, view the response example and schema."
},
{
"name": "sort-by",
"value": "",
"type": "query",
"description": "Specifies the field by which the results should be sorted."
},
{
"name": "sort-order",
"value": "",
"type": "query",
"description": "Sorts the specified field in ascending or descending order."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieve resolved issues based on set criteria. If you are comparing search results with the CyCognito app, note that Predefined Filters are not applied to data queried via the API by default."
}
]
}
],
"bundled": true
}