List Default Ids Profiles

List Default Ids Profiles
List default IDS profiles

Retrieves a paginated list of default IDS profiles. Results are sorted by display_name.

Notes

  • Supports optional filtering by profile_type (ENVIRONMENT or INFRASTRUCTURE).
  • Default offset is 0 and default page size is 100.
  • Returns 200 on success
Request
URI
GET
https://{api_host}/ssp/segmentation/default-ids-profiles
COPY
Query Parameters
integer
offset
Optional
Constraints: minimum: 0 default: 0

Offset pagination parameter used to exclude from a response the first N items of a resource collection. Combine the offset and the page_size options to request a particular set or page of items.

integer
page_size
Optional
Constraints: minimum: 0 default: 1000

Number of records to be returned in the API request from the provided offset

ProposedSecurityPolicyType
profile_type
Optional

Filter by IDS profile type (ENVIRONMENT or INFRASTRUCTURE)

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved default IDS profiles

Returns SegmentationIdsProfilesListResponse of type(s) application/json
This response body class contains all of the following: ListResult , InlineSegmentationIdsProfilesListResponse1 
{
    "offset": 0,
    "number_of_results": 2,
    "total_result_count": 2,
    "total_pages": 1,
    "sort_ascending": true,
    "sort_by": "displayName",
    "results": [
        {
            "id": "b8f47985-22ed-3193-bca8-11c7b025cbce",
            "display_name": "SSP_Env_IDPS_Profile",
            "description": "IDPS Profile for all environment traffic",
            "profile_type": "ENVIRONMENT",
            "publish_status": "PUBLISH_SUCCESS",
            "publish_action": "NONE",
            "severities": [
                "CRITICAL",
                "HIGH"
            ]
        },
        {
            "id": "c048c705-ee4f-326a-854a-d198829e5bce",
            "display_name": "SSP_Infra_IDPS_Profile",
            "description": "IDPS Profile for all infrastructure services",
            "profile_type": "INFRASTRUCTURE",
            "publish_status": "READY_TO_PUBLISH",
            "publish_action": "NONE",
            "severities": [
                "CRITICAL",
                "HIGH"
            ]
        }
    ]
}

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 -H 'Authorization: <value>' https://{api_host}/ssp/segmentation/default-ids-profiles
On This Page
Policy Onboarding Operations
POST
Query Proposed Security Policies
GET
Get Proposed Security Policy
PUT
Update Proposed Security Policy
DELETE
Delete Proposed Security Policy
GET
Get Proposed Security Policy Status
POST
Query Proposed Security Policy Rules
GET
Get Proposed Security Policy Rule
PUT
Update Proposed Security Policy Rule
DELETE
Delete Proposed Security Policy Rule
POST
Query Proposed Ids Security Policies
GET
Get Proposed Ids Security Policy
PUT
Update Proposed Ids Security Policy
DELETE
Delete Proposed Ids Security Policy
GET
Get Proposed Ids Security Policy Status
POST
Query Proposed Ids Security Policy Rules
GET
Get Proposed Ids Security Policy Rule
PUT
Update Proposed Ids Security Policy Rule
DELETE
Delete Proposed Ids Security Policy Rule
POST
Query Infra Service Categories
GET
Get Infra Segmentation Service Category
GET
List Default Ids Profiles
GET
Get Default Ids Profile
PUT
Update Default Ids Profile