Continuous Dynamic Help DocsContinuous Dynamic Portal Login (US)Continuous Dynamic Portal Login (EU)Customer Support
API Reference

Modify a site

put
https://sentinel.whitehatsec.com/api/site/

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

Path Params
int32
required

Site ID of the site to be updated.

Query Params
string
enum
Defaults to xml

Selects the requested response representation format.

Allowed:
Body Params

Update information for a single site.

string

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

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.

string

Free form description of the given site.

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:
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:
string
enum

General industry category used for aggregate statistics.

number
enum

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

Allowed:
number

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

number
enum

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

number
enum

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

Allowed:
string
enum

Indicates the phase of development the site is in.

Allowed:
string

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

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.

Updated 4 months ago

Language
Response 
 Choose an example:
application/json
application/xml
Updated 4 months ago