--- updatedAt: 2026-07-02T14:39:48.000Z --- # Modify a site This operation enables you to modify the information for a site. # OpenAPI definition ```json { "openapi": "3.0.0", "x-explorer-enabled": false, "info": { "title": "Site API (Legacy)", "license": { "name": "(c) Copyright 2021 WhiteHat Security" }, "version": "1.0.0" }, "servers": [ { "url": "https://sentinel.whitehatsec.com" } ], "paths": { "/api/site/{site_id}": { "put": { "tags": [ "Site API v1.0" ], "summary": "Modify a site", "description": "This operation enables you to modify the information for a site.", "operationId": "modifySite", "parameters": [ { "name": "site_id", "in": "path", "description": "Site ID of the site to be updated.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "format", "in": "query", "description": "Selects the requested response representation format.", "style": "form", "explode": true, "schema": { "type": "string", "default": "xml", "example": "json", "enum": [ "json", "xml" ] } } ], "requestBody": { "description": "Update information for a single site.", "content": { "application/json": { "encoding": {}, "schema": { "$ref": "#/components/schemas/SiteRequest" } } }, "required": true }, "responses": { "200": { "description": "Provides the updated information for a single site.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteObj" } }, "application/xml": { "example": "XML preview is currently not supported." } } }, "400": { "description": "BadRequestResponse indicates a request with invalid parameters.", "content": {} }, "401": { "description": "UnauthorizedResponse signals an unauthorized API access.", "content": {} }, "403": { "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.", "content": {} }, "500": { "description": "GenericError generic error.", "content": {} } }, "deprecated": false } } }, "components": { "schemas": { "SiteTags": { "type": "array", "description": "List of new tags. A maximum of 25 alphanumeric characters (plus underscore '_') per tag string is recommended.", "items": { "type": "string" } }, "SiteEntryPoint": { "properties": { "id": { "type": "number" }, "method": { "type": "string" }, "date_added_t": { "type": "string", "nullable": true }, "creator_id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "uri": { "type": "string" }, "maker": { "type": "string" }, "href": { "type": "string" }, "content": { "type": "string" } } }, "SiteScheduleSpec": { "properties": { "duration": { "type": "number", "nullable": true }, "cron_spec": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "time": { "type": "string" }, "weekday": { "type": "string" } } }, "SiteJob": { "properties": { "id": { "type": "string" } } }, "SiteSchedule": { "nullable": true, "properties": { "name": { "type": "string" }, "api-version": { "type": "number" }, "timezone": { "type": "string" }, "specs": { "type": "array", "items": { "$ref": "#/components/schemas/SiteScheduleSpec" } }, "id": { "type": "string" }, "start_date": { "type": "string", "nullable": true }, "job": { "$ref": "#/components/schemas/SiteJob" }, "href": { "type": "string" }, "creator": { "type": "string" } } }, "SiteCredStats": { "properties": { "invalid_business_logic_credentials": { "type": "number" }, "invalid_scanning_credentials": { "type": "number" } } }, "AccessIssues": { "type": "string" }, "Preset": { "properties": { "name": { "type": "string" }, "id": { "type": "string", "nullable": true } } }, "CustomPolicy": { "nullable": true, "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "SentinelFeatures": { "properties": { "name": { "type": "string" }, "purchased": { "type": "boolean" } } }, "Host": { "properties": { "id": { "type": "number" }, "scheme": { "type": "string" }, "href": { "type": "string" }, "hostname": { "type": "string" } } }, "Link": { "properties": { "url": { "type": "string" }, "reply_content": { "type": "string" }, "status": { "type": "string" }, "reply_code": { "type": "number" }, "state": { "type": "string", "nullable": true } } }, "Scan": { "nullable": true, "properties": { "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "name": { "type": "string", "nullable": true }, "id": { "type": "number" }, "begin": { "type": "string", "nullable": true }, "duration": { "type": "number", "nullable": true }, "data": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "end": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "nullable": true }, "job": { "type": "number" }, "href": { "type": "string", "nullable": true }, "requested_status": { "type": "string", "nullable": true }, "link_count": { "type": "number" } } }, "SiteVulnPolicy": { "properties": { "href": { "type": "string" }, "id": { "type": "string" } } }, "SiteCredential": { "nullable": true, "properties": { "expire_notify_before": { "type": "string", "nullable": true }, "cred_group_name": { "type": "string", "nullable": true }, "wh_managed": { "type": "boolean" }, "expire_type": { "type": "string", "nullable": true }, "selenium_script": { "type": "string", "nullable": true }, "updated_t": { "type": "number", "nullable": true }, "account_email": { "type": "string", "nullable": true }, "match_expression": { "type": "string", "nullable": true }, "secret_key": { "type": "string", "nullable": true }, "priority": { "type": "number", "nullable": true }, "expire_begin": { "type": "string", "nullable": true }, "expire_freeform": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "creator": { "type": "string", "nullable": true }, "href": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "id": { "type": "number" }, "login_valid_url": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "login_url": { "type": "string", "nullable": true }, "scanning_cred": { "type": "boolean" }, "pam_target": { "type": "string", "nullable": true, "description": "Target or Secret Path (for Vault app_role) identifier for PAM credential retrieval" }, "pam_integration_id": { "type": "number", "nullable": true, "description": "ID of the PAM integration to use for credential retrieval" }, "options": { "type": "string", "nullable": true, "description": "Additional options/configuration for the credential" } } }, "SiteGroup": { "properties": { "name": { "type": "string" }, "href": { "type": "string" }, "id": { "type": "number" } } }, "SeleniumScripts": { "type": "object" }, "BLA": { "properties": { "bla_status": { "type": "string" }, "last_bla_completed": { "type": "string" }, "last_bla_started": { "type": "string" } } }, "Severity": { "type": "object", "properties": { "high": { "type": "string" }, "critical": { "type": "string" }, "urgent": { "type": "string" }, "low": { "type": "string" }, "medium": { "type": "string" } } }, "Advanced": { "properties": { "customized": { "type": "string" }, "likelihood": { "$ref": "#/components/schemas/Score" }, "risk": { "$ref": "#/components/schemas/Score" }, "impact": { "$ref": "#/components/schemas/Score" } } }, "Score": { "properties": { "critical": { "type": "string" }, "high": { "type": "string" }, "medium": { "type": "string" }, "low": { "type": "string" }, "note": { "type": "string" } } }, "VulnStats": { "type": "object", "properties": { "severity": { "$ref": "#/components/schemas/Severity" }, "closed": { "type": "number" }, "open": { "oneOf": [ { "type": "number" }, { "type": "string" } ] }, "advanced": { "$ref": "#/components/schemas/Advanced" }, "out_of_scope": { "type": "number" }, "score": { "$ref": "#/components/schemas/Score" }, "accepted": { "type": "number" }, "customized": { "type": "string", "nullable": true } } }, "SiteObj": { "properties": { "custom_asset_id": { "type": "string", "nullable": true }, "label": { "type": "string" }, "host_bad": { "type": "string" }, "service_type": { "type": "string" }, "tags": { "$ref": "#/components/schemas/SiteTags" }, "entry_points": { "type": "array", "items": { "$ref": "#/components/schemas/SiteEntryPoint" } }, "client_id": { "type": "number" }, "scan_schedule": { "$ref": "#/components/schemas/SiteSchedule" }, "assessment_complete": { "type": "boolean" }, "wsi_industry_rank": { "type": "string", "nullable": true }, "asset_owner_name": { "type": "string" }, "first_completed_scan": { "$ref": "#/components/schemas/Scan" }, "organization": { "type": "string", "nullable": true }, "asset_phase": { "type": "string", "nullable": true }, "contract_end_date": { "type": "string", "nullable": true }, "site_credential_stats": { "$ref": "#/components/schemas/SiteCredStats" }, "access_issues": { "type": "array", "items": { "$ref": "#/components/schemas/AccessIssues" } }, "description": { "type": "string", "nullable": true }, "preset": { "$ref": "#/components/schemas/Preset" }, "custom_policy": { "$ref": "#/components/schemas/CustomPolicy" }, "sentinel_features": { "type": "array", "items": { "$ref": "#/components/schemas/SentinelFeatures" } }, "allowed_hosts": { "type": "array", "items": { "$ref": "#/components/schemas/Host" } }, "sentinel_feature_override": { "type": "array", "items": { "$ref": "#/components/schemas/SentinelFeatures" } }, "lh_bad": { "type": "string", "nullable": true }, "current_scan": { "$ref": "#/components/schemas/Scan" }, "vuln_policy": { "$ref": "#/components/schemas/SiteVulnPolicy" }, "last_completed_scan": { "$ref": "#/components/schemas/Scan" }, "wsi_score": { "type": "string", "nullable": true }, "site_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/SiteCredential" } }, "id": { "type": "number" }, "assessment_complete_date": { "type": "string", "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/SiteGroup" } }, "form_train_selenium_scripts": { "type": "array", "items": { "$ref": "#/components/schemas/SeleniumScripts" } }, "business_logic_assessment": { "$ref": "#/components/schemas/BLA" }, "wsi_global_rank": { "type": "string", "nullable": true }, "vuln_stats": { "$ref": "#/components/schemas/VulnStats" }, "asset_scan_status": { "type": "string", "nullable": true }, "scan_status": { "type": "array", "items": { "type": "string" } }, "activation_date": { "type": "string", "nullable": true }, "active_admin": { "type": "boolean" }, "active_consult": { "type": "boolean" }, "active_user": { "type": "boolean" }, "bla_cred_updated_by": { "type": "string", "nullable": true }, "bla_cred_updated_date": { "type": "string", "nullable": true }, "create_date": { "type": "number" }, "discovery": { "type": "boolean" }, "enable_bla_creds": { "type": "boolean" }, "enable_scan_creds": { "type": "boolean" }, "href": { "type": "string" }, "industry": { "type": "string" }, "satellite": { "type": "boolean" }, "scan_cred_updated_by": { "type": "string", "nullable": true }, "scan_cred_updated_date": { "type": "string", "nullable": true }, "scan_rate_limit": { "type": "number" }, "service_level": { "type": "string" }, "site_url": { "type": "string" }, "speed": { "type": "number" }, "visibility": { "type": "string" }, "weight": { "type": "number" }, "global_rank": { "type": "number", "nullable": true }, "market_rank": { "type": "string", "nullable": true }, "satellite_id": { "type": "number", "nullable": true } } }, "SiteRequest": { "properties": { "custom_asset_id": { "type": "string", "description": "A user-provided Custom Asset ID. This field is limited to under 20 characters. The following characters are not allowed: <, >, $, and \"" }, "asset_owner_id": { "type": "string", "description": "A user-provided field indicating the person in the customer organization who is responsible for this site. A valid Sentinel username (email address) is required." }, "description": { "type": "string", "description": "Free form description of the given site." }, "enable_scan_creds": { "type": "boolean", "description": "Indicates whether the site will be scanned authenticated with user-provided credentials. This defaults to 'false' for BE service level sites and 'true' for other service levels.", "enum": [ true, false ] }, "enable_bla_creds": { "type": "boolean", "description": "Indicates whether the Business Logic Assessment (BLA) credentials are enabled or disabled. This defaults to 'false' for BE service level sites and 'true' for other service levels.", "enum": [ true, false ] }, "industry": { "type": "string", "description": "General industry category used for aggregate statistics.", "enum": [ "Accommodation and Food Services", "Administrative and Support and Waste Management and Remediation Services", "Agriculture, Forestry, Fishing and Hunting", "Arts, Entertainment, and Recreation", "Construction", "Educational Services", "Finance and Insurance", "Health Care and Social Assistance", "Information", "Management of Companies and Enterprises", "Manufacturing", "Mining, Quarrying, and Oil and Gas Extraction", "Other Services (except Public Administration)", "Professional, Scientific, and Technical Services", "Public Administration", "Real Estate and Rental and Leasing", "Retail Trade", "Transportation and Warehousing", "Utilities", "Wholesale Trade" ] }, "speed": { "type": "number", "description": "The delay in seconds between sequential HTTP requests during a scan. 0 = no delay (fastest), 1.0 = 1 second delay (slowest).", "enum": [ 0, 0.125, 0.25, 0.5, 1 ] }, "vuln_policy_id": { "type": "number", "description": "The ID of the vulnerability policy resource (/api/vuln_policy/:vuln_policy_id) to be associated with the site." }, "weight": { "type": "number", "description": "A user-provided subjective scale used by the vulnerability scoring system. A value of 0 yields lower scores; 10 yields higher scores.", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ] }, "active_user": { "type": "number", "description": "A boolean flag indicating that the User (customer owner of the site) has approved scanning the site.", "enum": [ 0, 1 ] }, "asset_phase": { "type": "string", "description": "Indicates the phase of development the site is in.", "enum": [ "pre-production", "production", "discontinued" ] }, "slot_label": { "type": "string", "description": "A user-provided site label. Required to be under 100 characters and unique within a client (customer organization). Characters not allowed: '>', '<', '$', and \"" }, "satellite_id": { "type": "number", "description": "The satellite ID for the appliance this site will use for scanning (for internal intranet and development sites)." } } } } } } ```