GET v1/{subscriptionID}/projects/{projectID}/web/settings

Gets project's web settings.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

projectID

The project ID.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns the web settings of the specified project ID.

WebSettingsModel
NameDescriptionTypeAdditional information
WebSecurityToken

Gets the web security token of the project. Used for web purposes.

WebSecurityTokenModel

None.

Https

Gets and sets a value indicating whether a website is Https.

boolean

None.

RecipientAuthentication

Gets and sets a value indicating whether a website requires user authentication.

RecipientAuthenticationModel

None.

Response Formats

application/json, text/json

Sample:
{
  "WebSecurityToken": {
    "SecurityToken": "sample string 1",
    "ModificationTime": "2021-12-02T21:25:27.383141Z"
  },
  "Https": true,
  "RecipientAuthentication": {
    "UsernameAdor": "sample string 1",
    "PasswordAdor": "sample string 2",
    "PasswordHashing": 1
  }
}