Query Analysis Alerts

Query analysis alerts

Retrieves paginated list of alerts and issues identified during analysis, such as unresolved assets, naming conflicts, or configuration problems.

Request

URI

POST

https://{api_host}/ssp/segmentation/{session-id}/results/analysis-alerts

COPY

Path Parameters

string

session-id

Required

Unique identifier of the segmentation session

Request Body

Query parameters for filtering and pagination

AnalysisAlertsRequest of type(s) application/json

Required

This request body class requires all of the following: ListRequestParameters , InlineAnalysisAlertsRequest1

{
    "site_ids": [
        "123a456b-123c-456d-89ab-cdef12345678"
    ],
    "offset": 0,
    "page_size": 1000,
    "sort_ascending": false,
    "sort_by": "rowNumber"
}

Authentication

This operation uses the following authentication methods.

Responses

200

Successfully retrieved analysis alerts

Returns AnalysisAlertsResponse of type(s) application/json

This response body class contains all of the following: ListResult , InlineAnalysisAlertsResponse1

{
    "offset": 0,
    "number_of_results": 1,
    "total_result_count": 2,
    "total_pages": 2,
    "sort_ascending": false,
    "sort_by": "rowNumber",
    "results": [
        {
            "alert_type": "TAG_SCOPE_OVERLAP",
            "display_name": "9d2e1b8a-c45f-461b-ad3e-782f9b0c4d5e",
            "row": 7,
            "asset_identifier": "App-VM-2"
        }
    ]
}

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

412

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

428

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

429

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

default

Unexpected error

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/ssp/segmentation/{session-id}/results/analysis-alerts

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Asset Onboarding Operations

GET

List Segmentation Sessions