openapi: 3.2.0
info:
  title: WordPress.com REST API — wpcom/v2 namespace Hosting API
  version: v2
  description: Derived by API Evangelist from the WordPress.com REST API route index published at https://public-api.wordpress.com/wpcom/v2/. Paths, HTTP methods, and parameter names/types/descriptions/defaults are taken verbatim from that index. Response schemas are not published in the route index, so successful responses are described but not schematised; the error envelope was observed live on public-api.wordpress.com.
  contact:
    name: Automattic
    url: https://developer.wordpress.com/docs/api/
  x-derived-from: https://public-api.wordpress.com/wpcom/v2/
  x-derived-by: API Evangelist enrichment pipeline
servers:
- url: https://public-api.wordpress.com
security:
- bearerAuth: []
tags:
- name: hosting
paths:
  /wpcom/v2/hosting/github/accounts:
    post:
      operationId: postWpcomV2HostingGithubAccounts
      summary: POST /wpcom/v2/hosting/github/accounts
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                access_token:
                  type: string
              required:
              - access_token
  /wpcom/v2/hosting/github/app-authorize:
    get:
      operationId: getWpcomV2HostingGithubAppAuthorize
      summary: GET /wpcom/v2/hosting/github/app-authorize
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: redirect_uri
        in: query
        required: false
        schema:
          type: string
      - name: ux_mode
        in: query
        required: false
        schema:
          type: string
          default: popup
      - name: scope
        in: query
        required: false
        schema:
          type: string
          default: read:user,user:email
  /wpcom/v2/hosting/github/app-callback:
    get:
      operationId: getWpcomV2HostingGithubAppCallback
      summary: GET /wpcom/v2/hosting/github/app-callback
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: code
        in: query
        required: false
        schema:
          type: string
      - name: setup_action
        in: query
        required: false
        schema:
          type: string
          enum:
          - authorize
          - request
          - install
          - update
      - name: installation_id
        in: query
        required: false
        schema:
          type: integer
      - name: error
        in: query
        required: false
        schema:
          type: string
      - name: error_description
        in: query
        required: false
        schema:
          type: string
      - name: error_uri
        in: query
        required: false
        schema:
          type: string
      - name: state
        in: query
        required: false
        schema:
          type: string
  /wpcom/v2/hosting/github/app-install:
    get:
      operationId: getWpcomV2HostingGithubAppInstall
      summary: GET /wpcom/v2/hosting/github/app-install
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
  /wpcom/v2/hosting/github/app-webhook:
    post:
      operationId: postWpcomV2HostingGithubAppWebhook
      summary: POST /wpcom/v2/hosting/github/app-webhook
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
  /wpcom/v2/hosting/github/installations:
    get:
      operationId: getWpcomV2HostingGithubInstallations
      summary: GET /wpcom/v2/hosting/github/installations
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
  /wpcom/v2/hosting/github/repositories:
    get:
      operationId: getWpcomV2HostingGithubRepositories
      summary: GET /wpcom/v2/hosting/github/repositories
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: installation_id
        in: query
        required: true
        schema:
          type: number
        description: The installation ID of the GitHub App.
  /wpcom/v2/hosting/github/repository/branches:
    get:
      operationId: getWpcomV2HostingGithubRepositoryBranches
      summary: GET /wpcom/v2/hosting/github/repository/branches
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: installation_id
        in: query
        required: true
        schema:
          type: integer
      - name: repository_owner
        in: query
        required: true
        schema:
          type: string
      - name: repository_name
        in: query
        required: true
        schema:
          type: string
  /wpcom/v2/hosting/github/repository/pre-connect-checks:
    get:
      operationId: getWpcomV2HostingGithubRepositoryPreConnectChecks
      summary: GET /wpcom/v2/hosting/github/repository/pre-connect-checks
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: installation_id
        in: query
        required: true
        schema:
          type: integer
      - name: repository_owner
        in: query
        required: true
        schema:
          type: string
      - name: repository_name
        in: query
        required: true
        schema:
          type: string
      - name: repository_branch
        in: query
        required: true
        schema:
          type: string
  /wpcom/v2/hosting/github/workflow-templates:
    get:
      operationId: getWpcomV2HostingGithubWorkflowTemplates
      summary: GET /wpcom/v2/hosting/github/workflow-templates
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: template
        in: query
        required: true
        schema:
          type: string
          enum:
          - simple
          - with_composer
      - name: branch_name
        in: query
        required: true
        schema:
          type: string
  /wpcom/v2/hosting/github/workflows:
    get:
      operationId: getWpcomV2HostingGithubWorkflows
      summary: GET /wpcom/v2/hosting/github/workflows
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: repository_name
        in: query
        required: true
        schema:
          type: string
      - name: repository_owner
        in: query
        required: true
        schema:
          type: string
      - name: branch_name
        in: query
        required: true
        schema:
          type: string
    post:
      operationId: postWpcomV2HostingGithubWorkflows
      summary: POST /wpcom/v2/hosting/github/workflows
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                repository_owner:
                  type: string
                repository_name:
                  type: string
                branch_name:
                  type: string
                workflow_template:
                  type: string
                  enum:
                  - simple
                  - with_composer
              required:
              - repository_owner
              - repository_name
              - branch_name
              - workflow_template
  /wpcom/v2/hosting/github/workflows/checks:
    get:
      operationId: getWpcomV2HostingGithubWorkflowsChecks
      summary: GET /wpcom/v2/hosting/github/workflows/checks
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: repository_name
        in: query
        required: true
        schema:
          type: string
      - name: repository_owner
        in: query
        required: true
        schema:
          type: string
      - name: branch_name
        in: query
        required: true
        schema:
          type: string
      - name: workflow_filename
        in: query
        required: true
        schema:
          type: string
  /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments:
    get:
      operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeployments
      summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: query
        in: query
        required: false
        schema:
          type: string
        description: Query term to search for code deployments
    post:
      operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeployments
      summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                external_repository_id:
                  type: integer
                  description: The external repository ID.
                branch_name:
                  type: string
                  description: The branch to deploy.
                target_dir:
                  type: string
                  description: The target directory to deploy to.
                installation_id:
                  type: integer
                  description: The installation ID.
                is_automated:
                  type: boolean
                  description: Whether to deploy on a code push to the given branch or manually.
                workflow_path:
                  type: string
                  description: The path to the workflow file.
              required:
              - external_repository_id
              - branch_name
              - target_dir
              - installation_id
  /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}:
    get:
      operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId
      summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
    post:
      operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId
      summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                external_repository_id:
                  type: integer
                  description: The external repository ID.
                branch_name:
                  type: string
                  description: The branch to deploy.
                target_dir:
                  type: string
                  description: The target directory to deploy to.
                installation_id:
                  type: integer
                  description: The installation ID.
                is_automated:
                  type: boolean
                  description: Whether to deploy on a code push to the given branch or manually.
                workflow_path:
                  type: string
                  description: The path to the workflow file.
              required:
              - external_repository_id
              - branch_name
              - target_dir
              - installation_id
    put:
      operationId: putWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId
      summary: PUT /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                external_repository_id:
                  type: integer
                  description: The external repository ID.
                branch_name:
                  type: string
                  description: The branch to deploy.
                target_dir:
                  type: string
                  description: The target directory to deploy to.
                installation_id:
                  type: integer
                  description: The installation ID.
                is_automated:
                  type: boolean
                  description: Whether to deploy on a code push to the given branch or manually.
                workflow_path:
                  type: string
                  description: The path to the workflow file.
              required:
              - external_repository_id
              - branch_name
              - target_dir
              - installation_id
    patch:
      operationId: patchWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId
      summary: PATCH /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                external_repository_id:
                  type: integer
                  description: The external repository ID.
                branch_name:
                  type: string
                  description: The branch to deploy.
                target_dir:
                  type: string
                  description: The target directory to deploy to.
                installation_id:
                  type: integer
                  description: The installation ID.
                is_automated:
                  type: boolean
                  description: Whether to deploy on a code push to the given branch or manually.
                workflow_path:
                  type: string
                  description: The path to the workflow file.
              required:
              - external_repository_id
              - branch_name
              - target_dir
              - installation_id
    delete:
      operationId: deleteWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId
      summary: DELETE /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      - name: remove_files
        in: query
        required: false
        schema:
          type: string
        description: If true, the deployed files will be removed, if any.
  /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs:
    get:
      operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdRuns
      summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
    post:
      operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdRuns
      summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
  /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs/{deployment_run_id}/logs:
    get:
      operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdRunsbyDeploymentRunIdLogs
      summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs/{deployment_run_id}/logs
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      - name: deployment_run_id
        in: path
        required: true
        schema:
          type: string
  /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs/{deployment_run_id}/logs/{command_identifier}:
    get:
      operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdRunsbyDeploymentRunIdLogsbyCommandIdentifier
      summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs/{deployment_run_id}/logs/{command_identifier}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      - name: deployment_run_id
        in: path
        required: true
        schema:
          type: string
      - name: command_identifier
        in: path
        required: true
        schema:
          type: string
  /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks:
    post:
      operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooks
      summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL to receive notifications.
                events:
                  type: string
                  default: building,queued,started,completed,failed,cancelled
                  description: Comma-separated list of events to subscribe to. Defaults to all events.
              required:
              - url
    get:
      operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooks
      summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
  /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}:
    post:
      operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookId
      summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL.
                events:
                  type: string
                  description: Comma-separated list of events to subscribe to.
    put:
      operationId: putWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookId
      summary: PUT /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL.
                events:
                  type: string
                  description: Comma-separated list of events to subscribe to.
    patch:
      operationId: patchWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookId
      summary: PATCH /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: Webhook URL.
                events:
                  type: string
                  description: Comma-separated list of events to subscribe to.
    delete:
      operationId: deleteWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookId
      summary: DELETE /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
  /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}/deliveries:
    get:
      operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookIdDeliveries
      summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}/deliveries
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
  /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}/test:
    post:
      operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookIdTest
      summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}/test
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
  /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys:
    get:
      operationId: getWpcomV2SitesbyWpcomSiteHostingSshKeys
      summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
    post:
      operationId: postWpcomV2SitesbyWpcomSiteHostingSshKeys
      summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Name of the SSH key we want to attach. Currently only "default" is supported.
              required:
              - name
  /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys/{user_name}/{name}:
    delete:
      operationId: deleteWpcomV2SitesbyWpcomSiteHostingSshKeysbyUserNamebyName
      summary: DELETE /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys/{user_name}/{name}
      tags:
      - hosting
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: user_name
        in: path
        required: true
        schema:
          type: string
      - name: name
        in: path
        required: true
        schema:
          type: string
components:
  schemas:
    WPRestError:
      type: object
      description: WordPress REST API error envelope (observed on public-api.wordpress.com).
      properties:
        code:
          type: string
          example: rest_unauthorized
        message:
          type: string
          example: Authentication required.
        data:
          type: object
          properties:
            status:
              type: integer
              example: 401
  securitySchemes:
    oauth2:
      type: oauth2
      description: WordPress.com OAuth 2.1, per https://public-api.wordpress.com/.well-known/openid-configuration
      flows:
        authorizationCode:
          authorizationUrl: https://public-api.wordpress.com/oauth2-1/authorize
          tokenUrl: https://public-api.wordpress.com/oauth2-1/token
          refreshUrl: https://public-api.wordpress.com/oauth2-1/token
          scopes:
            global: ''
            auth: ''
            openid: ''
            profile: ''
            email: ''
            users: ''
            sites: ''
            posts: ''
            comments: ''
            taxonomy: ''
            follow: ''
            sharing: ''
            freshly-pressed: ''
            notifications: ''
            insights: ''
            read: ''
            stats: ''
            media: ''
            menus: ''
            batch: ''
            videos: ''
    bearerAuth:
      type: http
      scheme: bearer