Vendasta Website Pro Support Tools API
Website Pro SiteManager support tooling used to diagnose and operate managed WordPress sites.
OpenAPI Specification
{
"components": {
"schemas": {
"protobufAny": {
"additionalProperties": {},
"properties": {
"@type": {
"type": "string"
}
},
"type": "object"
},
"rpcStatus": {
"properties": {
"code": {
"format": "int32",
"type": "integer"
},
"details": {
"items": {
"$ref": "#/components/schemas/protobufAny"
},
"type": "array"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"v1ActivatePluginRequest": {
"description": "ActivatePluginRequest is the request message for ActivatePlugin.",
"properties": {
"pluginIds": {
"description": "Required. The list of plugin IDs to activate.",
"items": {
"type": "string"
},
"type": "array"
},
"siteId": {
"description": "Required. The unique identifier of the site.",
"type": "string"
}
},
"required": [
"siteId",
"pluginIds"
],
"type": "object"
},
"v1ChatCompletionRequest": {
"description": "ChatCompletionRequest is the request message for ChatCompletion.",
"properties": {
"text": {
"description": "Required. The input text for the chat completion.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"v1ChatCompletionResponse": {
"description": "ChatCompletionResponse is the response message for ChatCompletion.",
"properties": {
"resp": {
"description": "Output only. The generated response text.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"v1DeactivatePluginRequest": {
"description": "DeactivatePluginRequest is the request message for DeactivatePlugin.",
"properties": {
"pluginIds": {
"description": "Required. The list of plugin IDs to deactivate.",
"items": {
"type": "string"
},
"type": "array"
},
"siteId": {
"description": "Required. The unique identifier of the site.",
"type": "string"
}
},
"required": [
"siteId",
"pluginIds"
],
"type": "object"
},
"v1GetSiteResourceUsagesRequest": {
"description": "GetSiteResourceUsagesRequest is the request message for GetSiteResourceUsagesSummary.",
"properties": {
"monthYear": {
"description": "Optional. The month and year to get resource usage for (e.g., \"2024-01\").",
"type": "string"
},
"siteId": {
"description": "Required. The unique identifier of the site.",
"type": "string"
}
},
"required": [
"siteId"
],
"type": "object"
},
"v1GetSiteResourceUsagesResponse": {
"description": "GetSiteResourceUsagesResponse is the response message for GetSiteResourceUsagesSummary.",
"properties": {
"siteResourceUsages": {
"$ref": "#/components/schemas/v1SiteResourceUsages"
}
},
"type": "object"
},
"v1ListPluginsRequest": {
"description": "ListPluginsRequest is the request message for ListPlugins.",
"properties": {
"cursor": {
"description": "Optional. The cursor for pagination. Use the next_cursor from a previous response.",
"type": "string"
},
"pageSize": {
"description": "Optional. The number of plugins to return per page.",
"format": "int64",
"type": "string"
},
"siteId": {
"description": "Required. The unique identifier of the site.",
"type": "string"
}
},
"required": [
"siteId"
],
"type": "object"
},
"v1ListPluginsResponse": {
"description": "ListPluginsResponse is the response message for ListPlugins.",
"properties": {
"hasMore": {
"description": "Output only. Whether or not more results exist.",
"readOnly": true,
"type": "boolean"
},
"nextCursor": {
"description": "Output only. The cursor to use for the next page of results.",
"readOnly": true,
"type": "string"
},
"plugins": {
"description": "Output only. The list of plugins.",
"items": {
"$ref": "#/components/schemas/v1Plugin"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"v1Plugin": {
"description": "Plugin represents a WordPress plugin installed on a site.",
"properties": {
"id": {
"description": "Output only. The unique identifier of the WordPress plugin.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The display name of the WordPress plugin.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. The status of the plugin (active or inactive).",
"readOnly": true,
"type": "string"
},
"version": {
"description": "Output only. The version of the plugin currently installed.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"v1SiteResourceUsages": {
"description": "SiteResourceUsages contains resource usage data for a WordPress site.",
"properties": {
"bandwidth": {
"description": "Output only. The bandwidth usage of the site.",
"readOnly": true,
"type": "string"
},
"visitors": {
"description": "Output only. The visitor count for the site.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
},
"securitySchemes": {
"OAuth2": {
"flows": {
"authorizationCode": {
"authorizationUrl": "https://sso-api-prod.apigateway.co/oauth2/auth",
"scopes": {
"admin": "Allows the application to perform administrative tasks that you have access to across the platform",
"user:read": "Allows the application view-only access to all of your users in the platform"
},
"tokenUrl": "https://sso-api-prod.apigateway.co/oauth2/token"
}
},
"type": "oauth2"
}
}
},
"info": {
"title": "Wsp Support Tools",
"version": "0.6.0"
},
"openapi": "3.0.0",
"paths": {
"/v1/wph/support-tools/chat": {
"post": {
"operationId": "SiteManager_ChatCompletion",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ChatCompletionRequest"
}
}
},
"description": "ChatCompletionRequest is the request message for ChatCompletion.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ChatCompletionResponse"
}
}
},
"description": "A successful response."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/rpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"security": [
{
"OAuth2": [
"user:read"
]
}
],
"summary": "ChatCompletion",
"tags": [
"SiteManager"
]
}
},
"/v1/wph/support-tools/plugins": {
"post": {
"operationId": "SiteManager_ListPlugins",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListPluginsRequest"
}
}
},
"description": "ListPluginsRequest is the request message for ListPlugins.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListPluginsResponse"
}
}
},
"description": "A successful response."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/rpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"security": [
{
"OAuth2": [
"admin"
]
}
],
"summary": "ListPlugins represents a method for returning a list of plugins that the specified site has installed",
"tags": [
"SiteManager"
]
}
},
"/v1/wph/support-tools/plugins/activate": {
"post": {
"operationId": "SiteManager_ActivatePlugin",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ActivatePluginRequest"
}
}
},
"description": "ActivatePluginRequest is the request message for ActivatePlugin.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"description": "A successful response."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/rpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"security": [
{
"OAuth2": [
"admin"
]
}
],
"summary": "ActivatePlugins represents a method for activating a list of plugins for the specified site",
"tags": [
"SiteManager"
]
}
},
"/v1/wph/support-tools/plugins/deactivate": {
"post": {
"operationId": "SiteManager_DeactivatePlugin",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeactivatePluginRequest"
}
}
},
"description": "DeactivatePluginRequest is the request message for DeactivatePlugin.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"description": "A successful response."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/rpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"security": [
{
"OAuth2": [
"admin"
]
}
],
"summary": "DeactivatePlugins represents a method for deactivating a list of plugins for the site",
"tags": [
"SiteManager"
]
}
},
"/v1/wph/support-tools/resource-usage": {
"post": {
"operationId": "SiteManager_GetSiteResourceUsagesSummary",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1GetSiteResourceUsagesRequest"
}
}
},
"description": "GetSiteResourceUsagesRequest is the request message for GetSiteResourceUsagesSummary.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1GetSiteResourceUsagesResponse"
}
}
},
"description": "A successful response."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/rpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"security": [
{
"OAuth2": [
"admin"
]
}
],
"summary": "GetSiteSummary represents a method for getting the site details given an account id",
"tags": [
"SiteManager"
]
}
}
},
"servers": [
{
"description": "Production",
"url": "https://prod.apigateway.co/grpc"
}
],
"tags": [
{
"name": "SiteManager"
}
]
}