Get Site Feature Settings

• Site Service

Get site specific settings for features running on SSP.

Retrieve the site settings for SSP features for a specific site. The settings here DO NOT show whether a feature is activate or inactive on the platform, they only reflect the configured feature settings for each feature for the specified site. There is no need to create these feature settings, they are created as part of the onboarding workflow for the site.

Notes:

• Although all site feature settings are returned, not all of the settings are editable via API.

Request

URI

GET

https://{api_host}/ssp/sites/{site-id}/settings

COPY

Path Parameters

string

site-id

Required  

The site ID for which feature settings are being retrieved.

---

Authentication

This operation uses the following authentication methods.

enterprise_admin

auditor

security_engineer

security_op

Responses

200

Hide Details

OK

Returns SiteFeatureSettings of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineSiteFeatureSettings1

{
    "_resource_type": "SiteFeatureSettings",
    "_revision": 0,
    "id": "2dc09816-34c0-43fb-99a6-b19b249a43da",
    "site_ids": [
        "2dc09816-34c0-43fb-99a6-b19b249a43da"
    ],
    "is_intelligence_enabled": false,
    "is_metrics_enabled": true,
    "is_mps_enabled": false,
    "is_ndr_enabled": false,
    "is_rule_analysis_enabled": false
}

400

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

Unexpected error

Returns Error of type(s) application/json

{
    "error_code": 200001,
    "error_message": "An internal server error occurred.",
    "module_name": "site"
}

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/sites/{site-id}/settings
                

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Site Service Operations

GET

Retrieve All Sites

POST

Onboard Site

GET

Get Site By Id

PUT

Update Site

DELETE

Delete Site By Id

GET

Get Site Feature Settings

PUT

Update Site Feature Settings