Class SiteSettingsApi

SiteSettingsApi - object-oriented interface

export

Hierarchy

BaseAPI
- SiteSettingsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SiteSettingsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): SiteSettingsApi

Inherited from BaseAPI.constructor
- Defined in base.ts:50
Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns SiteSettingsApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

sitesSiteIdBackupDelete

sitesSiteIdBackupDelete(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9134
Disabling WordPress backups

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdBackupPost

sitesSiteIdBackupPost(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9145
Enabling WordPress backups

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdBasicAuthDelete

sitesSiteIdBasicAuthDelete(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9156
Disabling basic authentication

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdBasicAuthPost

sitesSiteIdBasicAuthPost(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9167
Enabling basic authentication

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdCdnStatusGet

sitesSiteIdCdnStatusGet(siteId: string, options?: any): Promise<AxiosResponse<CdnStatusGetResponse>>

- Defined in api.ts:9178
Get the Shifter CDN status

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- Optional options: any
Returns Promise<AxiosResponse<CdnStatusGetResponse>>

sitesSiteIdLogsPathDelete

sitesSiteIdLogsPathDelete(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9189
delete destination of access logs

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdLogsPathPut

sitesSiteIdLogsPathPut(siteId: string, s3BucketName: InlineObject6, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9201
set or update destination of access logs

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- s3BucketName: InlineObject6
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdMediaCdnDelete

sitesSiteIdMediaCdnDelete(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9212
Disabling media CDN

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdMediaCdnPost

sitesSiteIdMediaCdnPost(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9223
Enabling media CDN

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdProtectionDelete

sitesSiteIdProtectionDelete(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9234
remove protection of delete

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdProtectionPost

sitesSiteIdProtectionPost(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9245
add protection of delete

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdPut

sitesSiteIdPut(siteId: string, request: InlineObject2, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9257
update site settings. Updatable attributes are site_name, All in one WP migration configuration, Shifter media cdn configuration, and automatic publish configuration.

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- request: InlineObject2
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdSiteNamePut

sitesSiteIdSiteNamePut(siteId: string, request: InlineObject3, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9269
Update your site name

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- request: InlineObject3
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdSiteSubdirDelete

sitesSiteIdSiteSubdirDelete(siteId: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9280
Remove subdirectory name for publishing

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- Optional options: any
Returns Promise<AxiosResponse<void>>

sitesSiteIdSiteSubdirPut

sitesSiteIdSiteSubdirPut(siteId: string, dirName: InlineObject5, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:9292
Set subdirectory name for publishing

throws

{RequiredError}

memberof

SiteSettingsApi

Parameters
- siteId: string
  
  Site ID
- dirName: InlineObject5
- Optional options: any
Returns Promise<AxiosResponse<void>>

Generated using TypeDoc