Modify a site

put

https://sentinel.whitehatsec.com/api/site/{site_id}

This operation enables you to modify the information for a site.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

site_id

int32

required

Site ID of the site to be updated.

Query Params

format

string

enum

Defaults to xml

Selects the requested response representation format.

Allowed:

Body Params

Update information for a single site.

custom_asset_id

string

A user-provided Custom Asset ID. This field is limited to under 20 characters. The following characters are not allowed: <, >, $, and "

asset_owner_id

string

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

string

Free form description of the given site.

enable_scan_creds

boolean

enum

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.

Allowed:

enable_bla_creds

boolean

enum

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.

Allowed:

industry

string

enum

General industry category used for aggregate statistics.

speed

number

enum

The delay in seconds between sequential HTTP requests during a scan. 0 = no delay (fastest), 1.0 = 1 second delay (slowest).

Allowed:

vuln_policy_id

number

The ID of the vulnerability policy resource (/api/vuln_policy/:vuln_policy_id) to be associated with the site.

weight

number

enum

A user-provided subjective scale used by the vulnerability scoring system. A value of 0 yields lower scores; 10 yields higher scores.

active_user

number

enum

A boolean flag indicating that the User (customer owner of the site) has approved scanning the site.

Allowed:

asset_phase

string

enum

Indicates the phase of development the site is in.

Allowed:

slot_label

string

A user-provided site label. Required to be under 100 characters and unique within a client (customer organization). Characters not allowed: '>', '<', '$', and "

satellite_id

number

The satellite ID for the appliance this site will use for scanning (for internal intranet and development sites).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

500

GenericError generic error.

Language

Loading…

Response

Choose an example:

application/json

application/xml

200Provides the updated information for a single site.