Plesk API

openapi: 3.1.0
info:
  title: Plesk API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 8 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Plesk has published no machine-readable contract that the pipeline
    could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 5
    documentation: 3
    pages-with-code: 2
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.plesk.com/en-US/obsidian/api-rpc/about-rest-api.79359
  - https://docs.plesk.com/en-US/obsidian/partner-api-3.0/licenserelated-commands/searching-for-license-keys.77829
  - https://docs.plesk.com/en-US/obsidian/deployment-guide/plesk-installation-and-upgrade-on-single-server/1click-plesk-installation/installing-plesk-for-linux-in-one-click.76444
servers:
- url: https://autoinstall.plesk.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-rest-api.79359
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl . \n Swagger tools. \n Note: Swagger version 2.0 is deprecated, but is still available for backward compatibility. \n Regardless\
          \ of the tool you choose, a typical API request consists of the\nfollowing components: \n HTTP method \n URL \n Data type \n Transferred\
          \ data \n Authorization methods \n Let’s look closely at each one of them. \n 1 HTTP method \n Depending on the action you want to perform,\
          \ you u"
  /{id}/keys:
    get:
      operationId: get_id_keys
      tags:
      - Keys
      summary: Search for license keys by various filter criteria.
      x-source: https://docs.plesk.com/en-US/obsidian/partner-api-3.0/licenserelated-commands/searching-for-license-keys.77829
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: ip-address-binding
        in: query
        required: false
        schema:
          type: string
        description: Filter licenses by the IP address that a license key is bound to. Can be both IPv4 and IPv6.
      - name: nickname
        in: query
        required: false
        schema:
          type: string
        description: Filter licenses by an alias, custom tag, and other similar properties.
      - name: uid
        in: query
        required: false
        schema:
          type: string
        description: Filter licenses by the UID with which a license is activated.
      - name: product
        in: query
        required: false
        schema:
          type: string
        description: Filter licenses by product name aliases.
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter licenses by status. The allowed values are active, expired, expiring, terminated, suspended.
      - name: type
        in: query
        required: false
        schema:
          type: string
        description: Filter licenses by license type. The allowed values are master, trial, purchased, lease, lease1m, lease3m, lease6m, lease1y,
          lease2y, lease3y, bundled.
      - name: fraud
        in: query
        required: false
        schema:
          type: string
        description: 'Indicate that a license is detected as being used on multiple Plesk servers. The allowed value: confirmed_multiuse, potential_multiuse.'
      - name: restrict-ip-binding
        in: query
        required: false
        schema:
          type: boolean
        description: 'Indicate whether a license key can (false) or cannot (true) be used on IP addresses other than the IP address it is bound
          to. The allowed values: false, true.'
      - name: is-els
        in: query
        required: false
        schema:
          type: boolean
        description: 'Indicate whether a license key is being charged (true) or not (false) for Extended Lifecycle Support. The allowed values:
          false, true.'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIdKeysResponse'
      x-evidence:
        kind: documentation
  /api/v2/auth/keys:
    get:
      operationId: get_api_v2_auth_keys
      tags:
      - Api
      summary: Retrieves information about API keys.
      x-source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-rest-api.79359
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV2AuthKeysResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v2_auth_keys
      tags:
      - Api
      summary: POST /api/v2/auth/keys
      x-source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-rest-api.79359
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST --user root:password -H \"Content-Type: application/json\" -H \"Accept: application/json\" -d'{}' \"https://10.58.108.104:8443/api/v2/auth/keys\"\
          \n The key was created: \n { \"key\" : \"5c6f1a8a-1263-7444-24e5-fcfd7b4dcdc6\" } \n Now we will use this API key to authenticate all\
          \ following requests.\nLet’s get a list of all domains hosted on the server: "
  /api/v2/clients:
    get:
      operationId: get_api_v2_clients
      tags:
      - Api
      summary: Retrieves information about customers.
      x-source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-rest-api.79359
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v2_clients
      tags:
      - Api
      summary: POST /api/v2/clients
      x-source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-rest-api.79359
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2ClientsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"X-API-Key: 5c6f1a8a-1263-7444-24e5-fcfd7b4dcdc6\" -H \"Content-Type: application/json\" -H \"Accept: application/json\"\
          \ -d '{\"name\":\"John Doe\",\"login\":\"john_doe\",\"password\":\"password\",\"email\":\"john@doe.com\",\"type\":\"customer\",\"company\"\
          :\"Plesk\"}' \"https://10.58.108.105:8443/api/v2/clients\"\n The customer was added: \n { \"id\" : 2 , \"guid\" : \"9d4eb47b-817e-4c6b-b0ee-f2b7691986df\"\
          \ } \n Granting o"
  /api/v2/domains:
    get:
      operationId: get_api_v2_domains
      tags:
      - Api
      summary: GET /api/v2/domains
      x-source: https://docs.plesk.com/en-US/obsidian/api-rpc/about-rest-api.79359
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET -H \"X-API-Key: 5c6f1a8a-1263-7444-24e5-fcfd7b4dcdc6\" -H \"Content-Type: application/json\" -H \"Accept: application/json\"\
          \ \"https://10.58.108.104:8443/api/v2/domains\"\n Then, we add a new customer: "
  /one-click-installer:
    get:
      operationId: get_one_click_installer
      tags:
      - One Click Installer
      summary: GET /one-click-installer
      x-source: https://docs.plesk.com/en-US/obsidian/deployment-guide/plesk-installation-and-upgrade-on-single-server/1click-plesk-installation/installing-plesk-for-linux-in-one-click.76444
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://autoinstall.plesk.com/one-click-installer || wget -O - https://autoinstall.plesk.com/one-click-installer ) \n The\
          \ Plesk installation will proceed automatically.\nIt takes, on average, around 15 minutes.\nThe exact time can vary depending on the\
          \ network bandwidth, the network speed, the server OS version, and so on. \n The installer will download the latest\nstable Plesk release,\
          \ install it"
components:
  schemas:
    GetIdKeysResponse:
      type: object
      properties:
        ownerId:
          type: string
        keyId:
          type: integer
        parentKeyId:
          type: string
    GetApiV2AuthKeysResponse:
      type: object
      properties:
        key:
          type: string
    PostApiV2ClientsRequest:
      type: object
      properties:
        name:
          type: string
        login:
          type: string
        password:
          type: string
        email:
          type: string
        type:
          type: string
        company:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
security:
- apiKey: []
tags:
- name: Api
- name: Keys
- name: One Click Installer