hostinger-api-mcp 1.57.0

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "archive_path": {
      "type": "string",
      "description": "Directory, relative to the website document root, where the uploaded site archive currently lives. Most commonly this is simply `public_html`."
    }
  },
  "required": [
    "website_uid",
    "archive_path"
  ]
}

{
  "title": "Build website NodeJS assets",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "from_domain": {
      "type": "string",
      "description": "Current domain name to change from"
    },
    "domain": {
      "type": "string",
      "description": "New domain to assign to the website. Set to null to revert to the temporary domain."
    }
  },
  "required": [
    "website_uid",
    "from_domain",
    "domain"
  ]
}

{
  "title": "Change website domain",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "version": {
      "type": "string",
      "description": "Target WordPress core version to install. Must be one of the available versions."
    }
  },
  "required": [
    "website_uid",
    "version"
  ]
}

{
  "title": "Change WordPress version",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "Clear website cache",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "Agency Plan order ID"
    },
    "datacenter_code": {
      "type": "string",
      "description": "Datacenter code where the website should be provisioned. Available codes depend on live capacity and are not a fixed set."
    },
    "flavor": {
      "type": "string",
      "description": "Setup flavor: a specific WordPress version in the format `wp-<major>.<minor>` or `wp-<major>.<minor>.<patch>` (e.g. `wp-6.8.2`), or `php-fpm` for a plain PHP stack. Generic versions like `wp-latest` are not allowed."
    },
    "settings": {
      "type": "object",
      "description": "Website settings",
      "properties": {
        "php": {
          "type": "object",
          "description": "php parameter",
          "properties": {
            "version": {
              "type": "string",
              "description": "PHP version"
            }
          },
          "required": [
            "version"
          ]
        }
      },
      "required": [
        "php"
      ]
    },
    "domain": {
      "type": "string",
      "description": "Primary domain to attach to the website. Omit or set to null to get a free auto-generated *.hostingersite.com subdomain instead."
    },
    "type": {
      "type": "string",
      "description": "Website type",
      "enum": [
        "node-static"
      ]
    },
    "wordpress": {
      "type": "object",
      "description": "WordPress installation options",
      "properties": {
        "language": {
          "type": "string",
          "description": "language parameter"
        },
        "title": {
          "type": "string",
          "description": "title parameter"
        },
        "admin": {
          "type": "object",
          "description": "admin parameter",
          "properties": {
            "user": {
              "type": "string",
              "description": "user parameter"
            },
            "password": {
              "type": "string",
              "description": "password parameter"
            },
            "email": {
              "type": "string",
              "description": "email parameter"
            }
          },
          "required": [
            "user",
            "password",
            "email"
          ]
        }
      },
      "required": [
        "language",
        "title",
        "admin"
      ]
    }
  },
  "required": [
    "order_id",
    "datacenter_code",
    "flavor",
    "settings"
  ]
}

{
  "title": "Create a new website",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "time": {
      "type": "string",
      "description": "Cron schedule expression (standard 5-field crontab syntax)."
    },
    "command": {
      "type": "string",
      "description": "Command to run on the schedule. Must not contain pipe (|) or redirection (<, >) characters."
    }
  },
  "required": [
    "website_uid",
    "time",
    "command"
  ]
}

{
  "title": "Create website cron job",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "database_name": {
      "type": "string",
      "description": "Full database name as returned by the list databases endpoint."
    },
    "database_user": {
      "type": "string",
      "description": "Database username to create (alphanumeric and underscores)."
    },
    "password": {
      "type": "string",
      "description": "Password for the database user (requires mixed case, letters, and numbers)."
    },
    "host": {
      "type": "string",
      "description": "Host the user connects from (IPv4, IPv6, % wildcard, or localhost). Defaults to localhost."
    }
  },
  "required": [
    "website_uid",
    "database_name",
    "database_user",
    "password"
  ]
}

{
  "title": "Create website database user",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "database_name": {
      "type": "string",
      "description": "Database name to create (alphanumeric characters)."
    },
    "database_user": {
      "type": "string",
      "description": "Database username to create alongside the database (alphanumeric characters)."
    },
    "password": {
      "type": "string",
      "description": "Password for the database user (requires mixed case, letters, and numbers)."
    }
  },
  "required": [
    "website_uid",
    "database_name",
    "database_user",
    "password"
  ]
}

{
  "title": "Create website database",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "uuid": {
      "type": "string",
      "description": "Unique identifier of the cron job as returned by the list cron jobs endpoint."
    }
  },
  "required": [
    "website_uid",
    "uuid"
  ]
}

{
  "title": "Delete website cron job",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "database_name": {
      "type": "string",
      "description": "Full database name as returned by the list databases endpoint."
    },
    "database_user_name": {
      "type": "string",
      "description": "Database username as returned by the list databases endpoint."
    }
  },
  "required": [
    "website_uid",
    "database_name",
    "database_user_name"
  ]
}

{
  "title": "Delete website database user",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "database_name": {
      "type": "string",
      "description": "Full database name as returned by the list databases endpoint."
    }
  },
  "required": [
    "website_uid",
    "database_name"
  ]
}

{
  "title": "Delete website database",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "Delete website",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name of the Agency Plan website (e.g., example.com)"
    },
    "archivePath": {
      "type": "string",
      "description": "Absolute or relative path to the website archive file. Supported formats: zip, tar, tar.gz, tgz. The archive must contain the application source files. If user provides a directory path, create an archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mywebsite_20250115_143022.zip)"
    },
    "removeArchive": {
      "type": "boolean",
      "description": "Whether to remove the local archive file after successful deployment (default: true)"
    }
  },
  "required": [
    "domain",
    "archivePath"
  ]
}

{
  "title": "Deploy node-static website",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name of the Agency Plan website (e.g., example.com)"
    },
    "archivePath": {
      "type": "string",
      "description": "Absolute or relative path to the website archive file. Supported formats: zip, tar, tar.gz, tgz. If user provides a directory path, create an archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mywebsite_20250115_143022.zip)"
    },
    "removeArchive": {
      "type": "boolean",
      "description": "Whether to remove the local archive file after successful deployment (default: true)"
    }
  },
  "required": [
    "domain",
    "archivePath"
  ]
}

{
  "title": "Deploy PHP application",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "Generate upload URL",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "Get website details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "Agency Plan order ID"
    },
    "setup_uuid": {
      "type": "string",
      "description": "Website setup UUID"
    }
  },
  "required": [
    "order_id",
    "setup_uuid"
  ]
}

{
  "title": "Get website setup status",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "Get WordPress settings",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "archive_name": {
      "type": "string",
      "description": "Archive filename (e.g., archive.zip). The file must already be uploaded to the website's .h5g/ directory."
    }
  },
  "required": [
    "website_uid",
    "archive_name"
  ]
}

{
  "title": "Import website from archive",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "domain": {
      "type": "string",
      "description": "Fully qualified domain name to link to the website"
    }
  },
  "required": [
    "website_uid",
    "domain"
  ]
}

{
  "title": "Link domain to website",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "Agency Plan order ID"
    },
    "time_frame_days": {
      "type": "integer",
      "description": "Length of the window in days, ending now. Bucket size grows with the window.",
      "enum": [
        1,
        7,
        14,
        30
      ]
    }
  },
  "required": [
    "order_id"
  ]
}

{
  "title": "List Agency Plan order disk usage metrics",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    },
    "order_ids": {
      "type": "array",
      "description": "Filter by order IDs. Accepts a comma-separated list.",
      "items": {
        "type": "integer",
        "description": "order_ids parameter"
      }
    },
    "states": {
      "type": "array",
      "description": "Filter by website state. Accepts a comma-separated list.",
      "items": {
        "type": "string",
        "description": "states parameter",
        "enum": [
          "active",
          "locked",
          "suspended",
          "deleting",
          "deleted"
        ]
      }
    },
    "website_types": {
      "type": "array",
      "description": "Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.",
      "items": {
        "type": "string",
        "description": "website_types parameter",
        "enum": [
          "wordpress",
          "builder",
          "horizons",
          "nodejs",
          "other"
        ]
      }
    },
    "domain": {
      "type": "string",
      "description": "Filter by domain name (case-insensitive substring match)"
    }
  },
  "required": []
}

{
  "title": "List Agency Plan websites",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "Agency Plan order ID"
    }
  },
  "required": [
    "order_id"
  ]
}

{
  "title": "List available datacenters",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "Agency Plan order ID"
    }
  },
  "required": [
    "order_id"
  ]
}

{
  "title": "List available PHP versions for an order",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "List available PHP versions for a website",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "List available WordPress versions",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    },
    "website_uuids": {
      "type": "array",
      "description": "Filter by website UIDs",
      "items": {
        "type": "string",
        "description": "website_uuids parameter"
      }
    }
  },
  "required": []
}

{
  "title": "List domains",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "Agency Plan order ID"
    },
    "time_frame_hours": {
      "type": "integer",
      "description": "Length of the window in hours, ending now. Bucket size grows with the window.",
      "enum": [
        1,
        24,
        168,
        336,
        720
      ]
    }
  },
  "required": [
    "order_id"
  ]
}

{
  "title": "List order resource usage metrics",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": []
}

{
  "title": "List orders",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "List PHP extensions for a website",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "List PHP options for a website",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "List website cron jobs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "List website databases",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    }
  },
  "required": [
    "website_uid"
  ]
}

{
  "title": "List website processes",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "extensions": {
      "type": "array",
      "description": "Extension names, exactly as returned by the extensions endpoint.",
      "items": {
        "type": "string",
        "description": "extensions parameter"
      }
    }
  },
  "required": [
    "website_uid",
    "extensions"
  ]
}

{
  "title": "Replace website PHP extensions",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "options": {
      "type": "array",
      "description": "Option names and values. Each name must be one of the options returned by the options endpoint, and each value must satisfy that option's allowed_values when it declares them.",
      "items": {
        "type": "object",
        "description": "options parameter",
        "properties": {
          "name": {
            "type": "string",
            "description": "php.ini directive name."
          },
          "value": {
            "type": "string",
            "description": "Value to apply."
          }
        },
        "required": [
          "name",
          "value"
        ]
      }
    }
  },
  "required": [
    "website_uid",
    "options"
  ]
}

{
  "title": "Replace website PHP options",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "website_uid",
    "domain"
  ]
}

{
  "title": "Unlink domain from website",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "website_uid": {
      "type": "string",
      "description": "Agency Plan website UID"
    },
    "version": {
      "type": "string",
      "description": "PHP version to switch the website to, as major.minor. Must be one of the versions returned by the available versions endpoint."
    }
  },
  "required": [
    "website_uid",
    "version"
  ]
}

{
  "title": "Update website PHP version",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "payment_method_id": {
      "type": "integer",
      "description": "Payment method ID, default will be used if not provided"
    },
    "items": {
      "type": "array",
      "description": "Catalog price items to purchase",
      "items": {
        "type": "object",
        "description": "items parameter",
        "properties": {
          "item_id": {
            "type": "string",
            "description": "Catalog price item ID"
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity to purchase"
          }
        },
        "required": [
          "item_id"
        ]
      }
    },
    "coupons": {
      "type": "array",
      "description": "Discount coupon codes",
      "items": {
        "type": "string",
        "description": "coupons parameter"
      }
    }
  },
  "required": [
    "items"
  ]
}

{
  "title": "Create purchase order",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "paymentMethodId": {
      "type": "integer",
      "description": "Payment method ID"
    }
  },
  "required": [
    "paymentMethodId"
  ]
}

{
  "title": "Delete payment method",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "subscriptionId": {
      "type": "string",
      "description": "Subscription ID"
    }
  },
  "required": [
    "subscriptionId"
  ]
}

{
  "title": "Disable auto-renewal",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "subscriptionId": {
      "type": "string",
      "description": "Subscription ID"
    }
  },
  "required": [
    "subscriptionId"
  ]
}

{
  "title": "Enable auto-renewal",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "category": {
      "type": "string",
      "description": "Filter catalog items by category",
      "enum": [
        "DOMAIN",
        "VPS",
        "EMAIL"
      ]
    },
    "name": {
      "type": "string",
      "description": "Filter catalog items by name. Use `*` for wildcard search, e.g. `.COM*` to find .com domain"
    }
  },
  "required": []
}

{
  "title": "Get catalog item list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get payment method list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get subscription list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "subscriptionId": {
      "type": "string",
      "description": "Subscription ID"
    },
    "payment_method_id": {
      "type": "integer",
      "description": "Payment method ID, default will be used if not provided"
    },
    "coupons": {
      "type": "array",
      "description": "Discount coupon codes",
      "items": {
        "type": "string",
        "description": "coupons parameter"
      }
    }
  },
  "required": [
    "subscriptionId"
  ]
}

{
  "title": "Renew subscription",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "paymentMethodId": {
      "type": "integer",
      "description": "Payment method ID"
    }
  },
  "required": [
    "paymentMethodId"
  ]
}

{
  "title": "Set default payment method",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Delete DNS records",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get DNS records",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get DNS snapshot list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "snapshotId": {
      "type": "integer",
      "description": "Snapshot ID"
    }
  },
  "required": [
    "domain",
    "snapshotId"
  ]
}

{
  "title": "Get DNS snapshot",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "sync": {
      "type": "boolean",
      "description": "Determines if operation should be run synchronously"
    },
    "reset_email_records": {
      "type": "boolean",
      "description": "Determines if email records should be reset"
    },
    "whitelisted_record_types": {
      "type": "array",
      "description": "Specifies which record types to not reset",
      "items": {
        "type": "string",
        "description": "whitelisted_record_types parameter"
      }
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Reset DNS records",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "snapshotId": {
      "type": "integer",
      "description": "Snapshot ID"
    }
  },
  "required": [
    "domain",
    "snapshotId"
  ]
}

{
  "title": "Restore DNS snapshot",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "overwrite": {
      "type": "boolean",
      "description": "If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,\notherwise resource records' ttl's are updated and new records are appended.\nIf no matching RRs are found, they are created."
    },
    "zone": {
      "type": "array",
      "description": "zone parameter",
      "items": {
        "type": "object",
        "description": "zone parameter",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the record (use `@` for wildcard name)"
          },
          "records": {
            "type": "array",
            "description": "Records assigned to the name",
            "items": {
              "type": "object",
              "description": "records parameter",
              "properties": {
                "content": {
                  "type": "string",
                  "description": "Content of the name record"
                }
              },
              "required": [
                "content"
              ]
            }
          },
          "ttl": {
            "type": "integer",
            "description": "TTL (Time-To-Live) of the record"
          },
          "type": {
            "type": "string",
            "description": "Type of the record",
            "enum": [
              "A",
              "AAAA",
              "CNAME",
              "ALIAS",
              "MX",
              "TXT",
              "NS",
              "SOA",
              "SRV",
              "CAA"
            ]
          }
        },
        "required": [
          "name",
          "records",
          "type"
        ]
      }
    }
  },
  "required": [
    "domain",
    "zone"
  ]
}

{
  "title": "Update DNS records",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "overwrite": {
      "type": "boolean",
      "description": "If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,\notherwise resource records' ttl's are updated and new records are appended.\nIf no matching RRs are found, they are created."
    },
    "zone": {
      "type": "array",
      "description": "zone parameter",
      "items": {
        "type": "object",
        "description": "zone parameter",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the record (use `@` for wildcard name)"
          },
          "records": {
            "type": "array",
            "description": "Records assigned to the name",
            "items": {
              "type": "object",
              "description": "records parameter",
              "properties": {
                "content": {
                  "type": "string",
                  "description": "Content of the name record"
                }
              },
              "required": [
                "content"
              ]
            }
          },
          "ttl": {
            "type": "integer",
            "description": "TTL (Time-To-Live) of the record"
          },
          "type": {
            "type": "string",
            "description": "Type of the record",
            "enum": [
              "A",
              "AAAA",
              "CNAME",
              "ALIAS",
              "MX",
              "TXT",
              "NS",
              "SOA",
              "SRV",
              "CAA"
            ]
          }
        },
        "required": [
          "name",
          "records",
          "type"
        ]
      }
    }
  },
  "required": [
    "domain",
    "zone"
  ]
}

{
  "title": "Validate DNS records",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "domain_contacts": {
      "type": "object",
      "description": "WHOIS profiles of the accepting account. Only the contact types required by the TLD are applied, but all four IDs must be provided.",
      "properties": {
        "owner_id": {
          "type": "integer",
          "description": "Owner contact WHOIS record ID"
        },
        "admin_id": {
          "type": "integer",
          "description": "Administrative contact WHOIS record ID"
        },
        "billing_id": {
          "type": "integer",
          "description": "Billing contact WHOIS record ID"
        },
        "tech_id": {
          "type": "integer",
          "description": "Technical contact WHOIS record ID"
        }
      },
      "required": [
        "owner_id",
        "admin_id",
        "billing_id",
        "tech_id"
      ]
    }
  },
  "required": [
    "domain",
    "domain_contacts"
  ]
}

{
  "title": "Accept incoming domain move",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Cancel outgoing domain move",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Cancel pending IRTP verification",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "new_whois_id": {
      "type": "integer",
      "description": "WHOIS profile ID to assign to the domain"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "change_for": {
      "type": "array",
      "description": "Contact roles to repoint to the new WHOIS profile",
      "items": {
        "type": "string",
        "description": "change_for parameter",
        "enum": [
          "owner",
          "admin",
          "billing",
          "tech"
        ]
      }
    }
  },
  "required": [
    "new_whois_id",
    "domain",
    "change_for"
  ]
}

{
  "title": "Change WHOIS profile for domain",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name (without TLD)"
    },
    "tlds": {
      "type": "array",
      "description": "TLDs list",
      "items": {
        "type": "string",
        "description": "TLD without leading dot"
      }
    },
    "with_alternatives": {
      "type": "boolean",
      "description": "Should response include alternatives"
    }
  },
  "required": [
    "domain",
    "tlds"
  ]
}

{
  "title": "Check domain availability",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "auth_code": {
      "type": "string",
      "description": "Authorization code from the current registrar"
    },
    "domain_contacts": {
      "type": "object",
      "description": "Domain contact information",
      "properties": {
        "owner_id": {
          "type": "integer",
          "description": "Owner contact WHOIS record ID"
        },
        "admin_id": {
          "type": "integer",
          "description": "Administrative contact WHOIS record ID"
        },
        "billing_id": {
          "type": "integer",
          "description": "Billing contact WHOIS record ID"
        },
        "tech_id": {
          "type": "integer",
          "description": "Technical contact WHOIS record ID"
        }
      }
    },
    "should_keep_ns": {
      "type": "boolean",
      "description": "Keep the existing nameservers of the domain"
    }
  },
  "required": [
    "domain",
    "auth_code"
  ]
}

{
  "title": "Claim free domain transfer",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "domain_contacts": {
      "type": "object",
      "description": "Domain contact information",
      "properties": {
        "owner_id": {
          "type": "integer",
          "description": "Owner contact WHOIS record ID"
        },
        "admin_id": {
          "type": "integer",
          "description": "Administrative contact WHOIS record ID"
        },
        "billing_id": {
          "type": "integer",
          "description": "Billing contact WHOIS record ID"
        },
        "tech_id": {
          "type": "integer",
          "description": "Technical contact WHOIS record ID"
        }
      }
    },
    "additional_details": {
      "type": "object",
      "description": "Additional registration data, possible values depends on TLD",
      "properties": {}
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Claim free domain",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "redirect_type": {
      "type": "string",
      "description": "Redirect type",
      "enum": [
        "301",
        "302"
      ]
    },
    "redirect_url": {
      "type": "string",
      "description": "URL to forward domain to"
    }
  },
  "required": [
    "domain",
    "redirect_type",
    "redirect_url"
  ]
}

{
  "title": "Create domain forwarding",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "tld": {
      "type": "string",
      "description": "TLD of the domain (without leading dot)"
    },
    "country": {
      "type": "string",
      "description": "ISO 3166 2-letter country code"
    },
    "entity_type": {
      "type": "string",
      "description": "Legal entity type",
      "enum": [
        "individual",
        "organization"
      ]
    },
    "tld_details": {
      "type": "object",
      "description": "TLD details",
      "properties": {}
    },
    "whois_details": {
      "type": "object",
      "description": "WHOIS details",
      "properties": {}
    }
  },
  "required": [
    "tld",
    "entity_type",
    "country",
    "whois_details"
  ]
}

{
  "title": "Create WHOIS profile",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Delete domain forwarding",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "whoisId": {
      "type": "integer",
      "description": "WHOIS ID"
    }
  },
  "required": [
    "whoisId"
  ]
}

{
  "title": "Delete WHOIS profile",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Disable domain lock",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Disable privacy protection",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Enable domain lock",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Enable privacy protection",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get domain authorization code",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get domain details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get domain forwarding",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get domain list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get domain renewal information",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get incoming domain move list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "force_sync": {
      "type": "boolean",
      "description": "Re-check the move against the registry before responding. Only has an effect while the move is in the `activating` status."
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get incoming domain move",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get outgoing domain move list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get outgoing domain move",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get pending IRTP verification",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get transfer list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Get transfer",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "tld": {
      "type": "string",
      "description": "Filter by TLD (without leading dot)"
    }
  },
  "required": []
}

{
  "title": "Get WHOIS profile list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "whoisId": {
      "type": "integer",
      "description": "WHOIS ID"
    }
  },
  "required": [
    "whoisId"
  ]
}

{
  "title": "Get WHOIS profile usage",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "whoisId": {
      "type": "integer",
      "description": "WHOIS ID"
    }
  },
  "required": [
    "whoisId"
  ]
}

{
  "title": "Get WHOIS profile",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "item_id": {
      "type": "string",
      "description": "Catalog price item ID"
    },
    "payment_method_id": {
      "type": "integer",
      "description": "Payment method ID, default will be used if not provided"
    },
    "domain_contacts": {
      "type": "object",
      "description": "Domain contact information",
      "properties": {
        "owner_id": {
          "type": "integer",
          "description": "Owner contact WHOIS record ID"
        },
        "admin_id": {
          "type": "integer",
          "description": "Administrative contact WHOIS record ID"
        },
        "billing_id": {
          "type": "integer",
          "description": "Billing contact WHOIS record ID"
        },
        "tech_id": {
          "type": "integer",
          "description": "Technical contact WHOIS record ID"
        }
      }
    },
    "additional_details": {
      "type": "object",
      "description": "Additional registration data, possible values depends on TLD",
      "properties": {}
    },
    "coupons": {
      "type": "array",
      "description": "Discount coupon codes",
      "items": {
        "type": "string",
        "description": "coupons parameter"
      }
    }
  },
  "required": [
    "domain",
    "item_id"
  ]
}

{
  "title": "Purchase new domain",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Reject incoming domain move",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "whoisId": {
      "type": "integer",
      "description": "WHOIS ID"
    }
  },
  "required": [
    "whoisId"
  ]
}

{
  "title": "Set WHOIS profile as default",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "new_customer_email": {
      "type": "string",
      "description": "Email address of the Hostinger account receiving the domain"
    }
  },
  "required": [
    "domain",
    "new_customer_email"
  ]
}

{
  "title": "Start outgoing domain move",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Free-text description of the project the domain is needed for"
    },
    "limit": {
      "type": "integer",
      "description": "Amount of domain names to suggest"
    }
  },
  "required": [
    "description",
    "limit"
  ]
}

{
  "title": "Suggest domain names from a description",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name to base the suggestions on"
    },
    "limit": {
      "type": "integer",
      "description": "Amount of domain names to suggest"
    }
  },
  "required": [
    "domain",
    "limit"
  ]
}

{
  "title": "Suggest domain names from a domain",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "whoisId": {
      "type": "integer",
      "description": "WHOIS ID"
    }
  },
  "required": [
    "whoisId"
  ]
}

{
  "title": "Unset default WHOIS profile",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "redirect_type": {
      "type": "string",
      "description": "Redirect type",
      "enum": [
        "301",
        "302"
      ]
    },
    "redirect_url": {
      "type": "string",
      "description": "URL to forward domain to"
    }
  },
  "required": [
    "domain",
    "redirect_type",
    "redirect_url"
  ]
}

{
  "title": "Update domain forwarding",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "ns1": {
      "type": "string",
      "description": "First name server"
    },
    "ns2": {
      "type": "string",
      "description": "Second name server"
    },
    "ns3": {
      "type": "string",
      "description": "Third name server"
    },
    "ns4": {
      "type": "string",
      "description": "Fourth name server"
    }
  },
  "required": [
    "domain",
    "ns1",
    "ns2"
  ]
}

{
  "title": "Update domain nameservers",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the order."
    },
    "order_id": {
      "type": "string",
      "description": "The ID of the order to cancel."
    },
    "notify_customer": {
      "type": "boolean",
      "description": "Whether to email the customer about the cancellation. Defaults to true."
    }
  },
  "required": [
    "store_id",
    "order_id"
  ]
}

{
  "title": "Cancel an order",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to create the discount for."
    },
    "code": {
      "type": "string",
      "description": "The discount code customers enter at checkout."
    },
    "name": {
      "type": "string",
      "description": "A human-friendly discount name."
    },
    "type": {
      "type": "string",
      "description": "The discount type.",
      "enum": [
        "percentage",
        "fixed",
        "free_shipping"
      ]
    },
    "value": {
      "type": "integer",
      "description": "For percentage discounts a whole number 1-100; for fixed discounts an amount in the smallest currency unit (e.g. $10 is 1000). Ignored for free_shipping."
    },
    "allocation": {
      "type": "string",
      "description": "Whether the discount applies to the cart total or to each eligible item.",
      "enum": [
        "total",
        "item"
      ]
    },
    "starts_at": {
      "type": "string",
      "description": "When the discount becomes active. A bare date (2026-11-27) anchors to time_zone. Defaults to now when omitted."
    },
    "ends_at": {
      "type": "string",
      "description": "When the discount expires. A bare date runs to the end of that day in time_zone. Never expires when omitted."
    },
    "usage_limit": {
      "type": "integer",
      "description": "Maximum number of times the discount can be redeemed."
    },
    "min_cart_value": {
      "type": "integer",
      "description": "Minimum cart value in the smallest currency unit required for the discount to apply."
    },
    "time_zone": {
      "type": "string",
      "description": "IANA time zone used to interpret starts_at and ends_at."
    }
  },
  "required": [
    "store_id",
    "code",
    "type",
    "value"
  ]
}

{
  "title": "Create a discount",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to connect the payment provider to."
    },
    "provider_id": {
      "type": "string",
      "description": "The ID of the payment gateway to connect, e.g. stripe."
    }
  },
  "required": [
    "store_id",
    "provider_id"
  ]
}

{
  "title": "Create a payment provider connect link",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store the product belongs to."
    },
    "product_id": {
      "type": "string",
      "description": "The ID of the product the image will be attached to."
    }
  },
  "required": [
    "store_id",
    "product_id"
  ]
}

{
  "title": "Create a product image upload URL",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the product."
    },
    "product_id": {
      "type": "string",
      "description": "The ID of the product to add the variant to."
    },
    "title": {
      "type": "string",
      "description": "The variant title. Defaults to the option values joined with ' / ' (e.g. 'Red / L')."
    },
    "sku": {
      "type": "string",
      "description": "The variant SKU."
    },
    "options": {
      "type": "array",
      "description": "Option name/value pairs that distinguish this variant, e.g. [{name: Size, value: M}]. Options missing from the product are created; provide a value for every option the product already has.",
      "items": {
        "type": "object",
        "description": "options parameter",
        "properties": {
          "name": {
            "type": "string",
            "description": "Option name, e.g. Size."
          },
          "value": {
            "type": "string",
            "description": "Option value for this variant, e.g. M."
          }
        },
        "required": [
          "name",
          "value"
        ]
      }
    },
    "prices": {
      "type": "array",
      "description": "Prices per currency. Amounts are integers in the smallest currency unit. A free item is amount: 0.",
      "items": {
        "type": "object",
        "description": "prices parameter",
        "properties": {
          "amount": {
            "type": "integer",
            "description": "Price in the smallest currency unit (e.g. cents)."
          },
          "sale_amount": {
            "type": "integer",
            "description": "Optional sale price in the smallest currency unit; must be lower than amount."
          },
          "currency": {
            "type": "string",
            "description": "ISO 4217 currency code. Defaults to the store's default currency when omitted."
          }
        },
        "required": [
          "amount"
        ]
      }
    },
    "inventory_quantity": {
      "type": "integer",
      "description": "Units in stock. Defaults to 0."
    },
    "manage_inventory": {
      "type": "boolean",
      "description": "Whether stock is tracked for this variant. Defaults to false."
    }
  },
  "required": [
    "store_id",
    "product_id",
    "options"
  ]
}

{
  "title": "Create a product variant",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to create the sales channel for."
    },
    "type": {
      "type": "string",
      "description": "Sales channel type. \"custom\" is a headless channel: it requires a name and takes an optional public url.\n\"quick-link\" is a one-page store whose handle is auto-generated; it supports neither name nor url.",
      "enum": [
        "custom",
        "quick-link"
      ]
    },
    "name": {
      "type": "string",
      "description": "Merchant-facing custom name. Required for custom channels; not supported for quick-link."
    },
    "url": {
      "type": "string",
      "description": "Optional public url for the channel. Custom channels only; not supported for quick-link."
    }
  },
  "required": [
    "store_id",
    "type"
  ]
}

{
  "title": "Create a sales channel",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to create the product in."
    },
    "name": {
      "type": "string",
      "description": "The product name."
    },
    "price": {
      "type": "integer",
      "description": "Price in the smallest currency unit (e.g. cents). Must be positive."
    },
    "description": {
      "type": "string",
      "description": "The product description."
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code. Defaults to the store's default currency when omitted."
    },
    "download_url": {
      "type": "string",
      "description": "Optional external download link delivered to the customer after purchase."
    }
  },
  "required": [
    "store_id",
    "name",
    "price"
  ]
}

{
  "title": "Create digital product",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to create the product in."
    },
    "name": {
      "type": "string",
      "description": "The product name."
    },
    "price": {
      "type": "integer",
      "description": "Price in the smallest currency unit (e.g. cents). Must be positive."
    },
    "description": {
      "type": "string",
      "description": "The product description."
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code. Defaults to the store's default currency when omitted."
    }
  },
  "required": [
    "store_id",
    "name",
    "price"
  ]
}

{
  "title": "Create physical product",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "name parameter"
    },
    "country_code": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 country code."
    },
    "company_email": {
      "type": "string",
      "description": "company_email parameter"
    },
    "company_name": {
      "type": "string",
      "description": "company_name parameter"
    },
    "language": {
      "type": "string",
      "description": "ISO 639-1 language code."
    },
    "sales_channel": {
      "type": "object",
      "description": "sales_channel parameter",
      "properties": {
        "type": {
          "type": "string",
          "description": "Sales channel type. Only \"custom\" channels can be created via the API.",
          "enum": [
            "custom"
          ]
        },
        "external_id": {
          "type": "string",
          "description": "External identifier for the sales channel."
        }
      }
    }
  },
  "required": []
}

{
  "title": "Create store",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the product."
    },
    "product_id": {
      "type": "string",
      "description": "The ID of the product to delete."
    }
  },
  "required": [
    "store_id",
    "product_id"
  ]
}

{
  "title": "Delete a product",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the product."
    },
    "product_id": {
      "type": "string",
      "description": "The ID of the product that owns the variant."
    },
    "variant_id": {
      "type": "string",
      "description": "The ID of the variant to delete."
    }
  },
  "required": [
    "store_id",
    "product_id",
    "variant_id"
  ]
}

{
  "title": "Delete a product variant",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to delete."
    }
  },
  "required": [
    "store_id"
  ]
}

{
  "title": "Delete store",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to enable manual payment for."
    },
    "title": {
      "type": "string",
      "description": "Optional display name shown to customers at checkout."
    }
  },
  "required": [
    "store_id"
  ]
}

{
  "title": "Enable manual payment method",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the order."
    },
    "order_id": {
      "type": "string",
      "description": "The ID of the order to fulfil."
    },
    "items": {
      "type": "array",
      "description": "Line items to fulfil. Omit to fulfil every remaining unfulfilled item.",
      "items": {
        "type": "object",
        "description": "items parameter",
        "properties": {
          "line_item_id": {
            "type": "string",
            "description": "The line item to fulfil, from the order detail items[].id."
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of the line item to fulfil."
          }
        },
        "required": [
          "line_item_id",
          "quantity"
        ]
      }
    },
    "tracking_number": {
      "type": "string",
      "description": "Carrier tracking number for the shipment."
    },
    "tracking_url": {
      "type": "string",
      "description": "Public tracking URL for the shipment. Requires tracking_number."
    },
    "notify_customer": {
      "type": "boolean",
      "description": "Whether to email the customer about the fulfilment. Defaults to true."
    }
  },
  "required": [
    "store_id",
    "order_id"
  ]
}

{
  "title": "Fulfil an order",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get custom storefront setup instructions",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to read metadata for."
    }
  },
  "required": [
    "store_id"
  ]
}

{
  "title": "Get store metadata",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": []
}

{
  "title": "Get stores",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to list discounts for."
    },
    "q": {
      "type": "string",
      "description": "Free-text search over discount code and name."
    },
    "is_disabled": {
      "type": "string",
      "description": "Filter by disabled state.",
      "enum": [
        "true",
        "false"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "store_id"
  ]
}

{
  "title": "List discounts",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to list products for."
    },
    "product_ids": {
      "type": "array",
      "description": "Restrict to these product ids. Doubles as a single-product lookup. Up to 200 ids.",
      "items": {
        "type": "string",
        "description": "product_ids parameter"
      }
    },
    "status": {
      "type": "array",
      "description": "Product statuses to include.",
      "items": {
        "type": "string",
        "description": "status parameter",
        "enum": [
          "draft",
          "proposed",
          "published",
          "rejected",
          "archived"
        ]
      }
    },
    "q": {
      "type": "string",
      "description": "Free-text search over product title and SKU."
    },
    "include": {
      "type": "array",
      "description": "Opt-in heavy data: \"variants\" embeds each product's variants; \"media\" embeds its media.",
      "items": {
        "type": "string",
        "description": "include parameter",
        "enum": [
          "variants",
          "media"
        ]
      }
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "store_id"
  ]
}

{
  "title": "List products",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the product."
    },
    "product_id": {
      "type": "string",
      "description": "The ID of the product to list variants for."
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "store_id",
    "product_id"
  ]
}

{
  "title": "List product variants",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to list sales channels for."
    }
  },
  "required": [
    "store_id"
  ]
}

{
  "title": "List sales channels",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to list orders for."
    },
    "status": {
      "type": "array",
      "description": "Order statuses to include.",
      "items": {
        "type": "string",
        "description": "status parameter",
        "enum": [
          "pending",
          "completed",
          "archived",
          "canceled",
          "requires_action"
        ]
      }
    },
    "payment_status": {
      "type": "array",
      "description": "Payment statuses to include. A paid order is \"captured\".",
      "items": {
        "type": "string",
        "description": "payment_status parameter",
        "enum": [
          "not_paid",
          "awaiting",
          "captured",
          "partially_refunded",
          "refunded",
          "canceled",
          "requires_action",
          "not_required"
        ]
      }
    },
    "fulfillment_status": {
      "type": "array",
      "description": "Fulfilment statuses to include.",
      "items": {
        "type": "string",
        "description": "fulfillment_status parameter",
        "enum": [
          "not_fulfilled",
          "partially_fulfilled",
          "fulfilled",
          "partially_shipped",
          "shipped",
          "partially_returned",
          "returned",
          "canceled",
          "requires_action"
        ]
      }
    },
    "email": {
      "type": "string",
      "description": "Customer email, matched exactly."
    },
    "display_id": {
      "type": "string",
      "description": "The order number the merchant and customer see."
    },
    "q": {
      "type": "string",
      "description": "Free-text search over customer name, email, order number and line items."
    },
    "created_at_from": {
      "type": "string",
      "description": "Earliest creation time to include, inclusive. Accepts a date or ISO date-time (UTC)."
    },
    "created_at_to": {
      "type": "string",
      "description": "Latest creation time to include, inclusive. A bare date covers that whole day."
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "store_id"
  ]
}

{
  "title": "List store orders",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to list payment providers for."
    },
    "include_currency_unsupported": {
      "type": "boolean",
      "description": "Include gateways that do not support the store currency in the available list."
    }
  },
  "required": [
    "store_id"
  ]
}

{
  "title": "List store payment providers",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the order."
    },
    "order_id": {
      "type": "string",
      "description": "The ID of the order to retrieve."
    }
  },
  "required": [
    "store_id",
    "order_id"
  ]
}

{
  "title": "Retrieve an order",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store to configure shipping for."
    },
    "price": {
      "type": "integer",
      "description": "Flat shipping rate in the smallest currency unit (e.g. cents). Use 0 for free shipping."
    }
  },
  "required": [
    "store_id",
    "price"
  ]
}

{
  "title": "Set store shipping",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the product."
    },
    "product_id": {
      "type": "string",
      "description": "The ID of the product to update."
    },
    "name": {
      "type": "string",
      "description": "The product name."
    },
    "description": {
      "type": "string",
      "description": "The product description."
    },
    "status": {
      "type": "string",
      "description": "Set \"published\" to make the product buyable, \"draft\" to hide it, or \"archived\" to retire it.",
      "enum": [
        "draft",
        "published",
        "archived"
      ]
    }
  },
  "required": [
    "store_id",
    "product_id"
  ]
}

{
  "title": "Update a product",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the product."
    },
    "product_id": {
      "type": "string",
      "description": "The ID of the product whose variants are being updated."
    },
    "variants": {
      "type": "array",
      "description": "Variants to update in place by id, up to 100. Variants omitted from the list are left untouched.",
      "items": {
        "type": "object",
        "description": "variants parameter",
        "properties": {
          "variant_id": {
            "type": "string",
            "description": "The id of the variant to update."
          },
          "title": {
            "type": "string",
            "description": "The variant title."
          },
          "inventory_quantity": {
            "type": "integer",
            "description": "Units in stock."
          },
          "manage_inventory": {
            "type": "boolean",
            "description": "Whether stock is tracked for this variant."
          },
          "prices": {
            "type": "array",
            "description": "The full list of prices for the variant, replacing the existing ones. A free item is amount: 0.",
            "items": {
              "type": "object",
              "description": "prices parameter",
              "properties": {
                "amount": {
                  "type": "integer",
                  "description": "Price in the smallest currency unit (e.g. cents)."
                },
                "sale_amount": {
                  "type": "integer",
                  "description": "Optional sale price in the smallest currency unit; must be lower than amount."
                },
                "currency": {
                  "type": "string",
                  "description": "ISO 4217 currency code. Defaults to the store's default currency."
                }
              },
              "required": [
                "amount"
              ]
            }
          }
        },
        "required": [
          "variant_id"
        ]
      }
    }
  },
  "required": [
    "store_id",
    "product_id",
    "variants"
  ]
}

{
  "title": "Update product variants in batch",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store that owns the sales channel."
    },
    "sales_channel_id": {
      "type": "string",
      "description": "The ID of the sales channel to update."
    },
    "name": {
      "type": "string",
      "description": "Merchant-facing custom name shown in the sales channels list. Pass null to clear it."
    },
    "url": {
      "type": "string",
      "description": "Public address where the custom sales channel lives. Pass null to clear it."
    }
  },
  "required": [
    "store_id",
    "sales_channel_id"
  ]
}

{
  "title": "Update sales channel",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "string",
      "description": "The ID of the store the product belongs to."
    },
    "product_id": {
      "type": "string",
      "description": "The ID of the product to attach the image to."
    },
    "image_url": {
      "type": "string",
      "description": "Publicly reachable URL of the raster image (JPEG, PNG, GIF or WebP), maximum 15MB. The image is\nfetched, virus-scanned and validated by content, then stored on the CDN. SVG is not accepted.\nProvide either this or object_name."
    },
    "object_name": {
      "type": "string",
      "description": "Key returned by the upload-url endpoint. Provide this instead of image_url to attach an uploaded image."
    },
    "is_thumbnail": {
      "type": "boolean",
      "description": "When true, the image becomes the product's thumbnail (primary image). When omitted, it becomes the\nthumbnail only if the product does not have one yet."
    }
  },
  "required": [
    "store_id",
    "product_id"
  ]
}

{
  "title": "Upload and attach a product image",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "array",
      "description": "message parameter",
      "items": {
        "type": "object",
        "description": "message parameter",
        "properties": {
          "type": {
            "type": "string",
            "description": "type parameter",
            "enum": [
              "text"
            ]
          },
          "text": {
            "type": "string",
            "description": "Detailed project specification.\nInclude purpose, key features, user flows, data models, and design preferences.\nThe specification should be detailed and comprehensive, covering all aspects of the project."
          }
        },
        "required": [
          "type",
          "text"
        ]
      }
    }
  },
  "required": [
    "message"
  ]
}

{
  "title": "Create website",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "websiteId": {
      "type": "string",
      "description": "The website ID"
    }
  },
  "required": [
    "websiteId"
  ]
}

{
  "title": "Get website",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "plugin": {
      "type": "string",
      "description": "Slug of the installed plugin to activate."
    }
  },
  "required": [
    "username",
    "software",
    "plugin"
  ]
}

{
  "title": "Activate WordPress plugin",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "theme": {
      "type": "string",
      "description": "Slug of the installed theme to activate."
    }
  },
  "required": [
    "username",
    "software",
    "theme"
  ]
}

{
  "title": "Activate WordPress theme",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "uuid": {
      "type": "string",
      "description": "Build UUID"
    }
  },
  "required": [
    "username",
    "domain",
    "uuid"
  ]
}

{
  "title": "Analyse failed Node.js build",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "name": {
      "type": "string",
      "description": "Full database name as returned by the list databases endpoint."
    },
    "password": {
      "type": "string",
      "description": "New database user password."
    }
  },
  "required": [
    "username",
    "name",
    "password"
  ]
}

{
  "title": "Change database password",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Filter by domain name (case-insensitive substring match)"
    }
  },
  "required": []
}

{
  "title": "Check if WooCommerce is installed",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software_ids": {
      "type": "array",
      "description": "WordPress installation (software) identifiers to validate.",
      "items": {
        "type": "string",
        "description": "Software identifier"
      }
    },
    "force": {
      "type": "boolean",
      "description": "Force fresh validation without cache. Preferable for troubleshooting purposes."
    }
  },
  "required": [
    "username",
    "software_ids"
  ]
}

{
  "title": "Check if WordPress installations are valid",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Clear Node.js runtime logs",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "directory": {
      "type": "string",
      "description": "Directory of the website installation to clear, relative to the website root.\nDefaults to the website root."
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Clear website cache",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "time": {
      "type": "string",
      "description": "Cron schedule expression (for example \"0 2 * * *\" runs daily at 02:00)."
    },
    "command": {
      "type": "string",
      "description": "Command to execute on the schedule."
    }
  },
  "required": [
    "username",
    "time",
    "command"
  ]
}

{
  "title": "Create account cron job",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "name": {
      "type": "string",
      "description": "Database name. If the account username prefix is omitted, it is added automatically."
    },
    "user": {
      "type": "string",
      "description": "Database user. If the account username prefix is omitted, it is added automatically."
    },
    "password": {
      "type": "string",
      "description": "Database user password."
    },
    "website_domain": {
      "type": "string",
      "description": "Website domain assigned to the database."
    }
  },
  "required": [
    "username",
    "name",
    "user",
    "password",
    "website_domain"
  ]
}

{
  "title": "Create account database",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "name": {
      "type": "string",
      "description": "Full database name as returned by the list databases endpoint."
    },
    "ip": {
      "type": "string",
      "description": "Remote host to allow: an IPv4/IPv6 address, or \"%\" for any host."
    }
  },
  "required": [
    "username",
    "name",
    "ip"
  ]
}

{
  "title": "Create database remote connection",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Create login links",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "parked_domain": {
      "type": "string",
      "description": "Domain name or IP address to park on the selected website"
    }
  },
  "required": [
    "username",
    "domain",
    "parked_domain"
  ]
}

{
  "title": "Create website parked domain",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "from": {
      "type": "string",
      "description": "Source URL on the selected website"
    },
    "to": {
      "type": "string",
      "description": "Destination URL or IP address"
    }
  },
  "required": [
    "username",
    "domain",
    "from",
    "to"
  ]
}

{
  "title": "Create website redirect",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "subdomain": {
      "type": "string",
      "description": "Subdomain prefix to create under the selected website"
    },
    "directory": {
      "type": "string",
      "description": "Directory name for the subdomain relative to the website root"
    },
    "is_using_public_directory": {
      "type": "boolean",
      "description": "Use the website public directory as the subdomain root directory"
    }
  },
  "required": [
    "username",
    "domain",
    "subdomain"
  ]
}

{
  "title": "Create website subdomain",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name for the website. Cannot start with \"www.\""
    },
    "order_id": {
      "type": "integer",
      "description": "ID of the associated order"
    },
    "datacenter_code": {
      "type": "string",
      "description": "Datacenter code. This parameter is required when creating the first website on a new hosting plan."
    }
  },
  "required": [
    "domain",
    "order_id"
  ]
}

{
  "title": "Create website",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "plugin": {
      "type": "string",
      "description": "Slug of the installed plugin to deactivate."
    }
  },
  "required": [
    "username",
    "software",
    "plugin"
  ]
}

{
  "title": "Deactivate WordPress plugin",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "uid": {
      "type": "string",
      "description": "Unique identifier of the cron job as returned by the list cron jobs endpoint."
    }
  },
  "required": [
    "username",
    "uid"
  ]
}

{
  "title": "Delete account cron job",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "name": {
      "type": "string",
      "description": "Full database name as returned by the list databases endpoint."
    }
  },
  "required": [
    "username",
    "name"
  ]
}

{
  "title": "Delete account database",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "name": {
      "type": "string",
      "description": "Full database name as returned by the list databases endpoint."
    },
    "ip": {
      "type": "string",
      "description": "Remote host to revoke: the IPv4/IPv6 address, or \"%\",\nexactly as returned by the list remote connections endpoint."
    }
  },
  "required": [
    "username",
    "name",
    "ip"
  ]
}

{
  "title": "Delete database remote connection",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "parkedDomain": {
      "type": "string",
      "description": "parkedDomain parameter"
    }
  },
  "required": [
    "username",
    "domain",
    "parkedDomain"
  ]
}

{
  "title": "Delete website parked domain",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "from": {
      "type": "string",
      "description": "Source URL returned by the list redirects endpoint."
    }
  },
  "required": [
    "username",
    "domain",
    "from"
  ]
}

{
  "title": "Delete website redirect",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "subdomain": {
      "type": "string",
      "description": "subdomain parameter"
    }
  },
  "required": [
    "username",
    "domain",
    "subdomain"
  ]
}

{
  "title": "Delete website subdomain",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Delete website",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Delete WordPress installation",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name associated with the hosting account (e.g., example.com)"
    },
    "archivePath": {
      "type": "string",
      "description": "Absolute or relative path to the application archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory."
    },
    "removeArchive": {
      "type": "boolean",
      "description": "Whether to remove the archive file after successful deployment (default: false)"
    }
  },
  "required": [
    "domain",
    "archivePath"
  ]
}

{
  "title": "Deploy JavaScript application",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "archive_path": {
      "type": "string",
      "description": "Relative path to the archive file from website root directory"
    }
  },
  "required": [
    "username",
    "domain",
    "archive_path"
  ]
}

{
  "title": "Deploy static site archive",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name associated with the hosting account (e.g., example.com)"
    },
    "archivePath": {
      "type": "string",
      "description": "Absolute or relative path to the static website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mystaticwebsite_20250115_143022.zip)"
    },
    "removeArchive": {
      "type": "boolean",
      "description": "Whether to remove the archive file after successful deployment (default: false)"
    }
  },
  "required": [
    "domain",
    "archivePath"
  ]
}

{
  "title": "Deploy static website",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name associated with the hosting account (e.g., example.com)"
    },
    "slug": {
      "type": "string",
      "description": "WordPress plugin slug (e.g., omnisend)"
    },
    "pluginPath": {
      "type": "string",
      "description": "Absolute or relative path to the plugin directory containing all plugin files"
    }
  },
  "required": [
    "domain",
    "slug",
    "pluginPath"
  ]
}

{
  "title": "Deploy WordPress plugin",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "slug": {
      "type": "string",
      "description": "Slug of the plugin"
    },
    "plugin_path": {
      "type": "string",
      "description": "Relative path to the plugin directory from wp-content/plugins"
    }
  },
  "required": [
    "username",
    "domain",
    "slug",
    "plugin_path"
  ]
}

{
  "title": "Deploy WordPress plugin",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name associated with the hosting account (e.g., example.com)"
    },
    "slug": {
      "type": "string",
      "description": "WordPress theme slug (e.g., twentytwentyfive)"
    },
    "themePath": {
      "type": "string",
      "description": "Absolute or relative path to the theme directory containing all theme files"
    },
    "activate": {
      "type": "boolean",
      "description": "Whether to activate the theme after deployment (default: false)"
    }
  },
  "required": [
    "domain",
    "slug",
    "themePath"
  ]
}

{
  "title": "Deploy WordPress theme",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "slug": {
      "type": "string",
      "description": "Slug of the theme"
    },
    "theme_path": {
      "type": "string",
      "description": "Relative path to the theme directory from wp-content/themes"
    },
    "is_activated": {
      "type": "boolean",
      "description": "Whether to activate the theme after deployment"
    }
  },
  "required": [
    "username",
    "domain",
    "slug",
    "theme_path"
  ]
}

{
  "title": "Deploy WordPress theme",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    }
  },
  "required": [
    "username"
  ]
}

{
  "title": "Detect WordPress installations",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Generate a free subdomain",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "Account username"
    },
    "domain": {
      "type": "string",
      "description": "Website domain"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Generate upload URL",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "uid": {
      "type": "string",
      "description": "Unique identifier of the cron job as returned by the list cron jobs endpoint."
    }
  },
  "required": [
    "username",
    "uid"
  ]
}

{
  "title": "Get cron job output",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Get installation JWT token",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "uuid": {
      "type": "string",
      "description": "Build UUID"
    }
  },
  "required": [
    "username",
    "domain",
    "uuid"
  ]
}

{
  "title": "Get Node.js build details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "archive_path": {
      "type": "string",
      "description": "The path to the archive file relative to the document root of the vhost"
    }
  },
  "required": [
    "username",
    "domain",
    "archive_path"
  ]
}

{
  "title": "Get Node.js build settings from archive",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Get Node.js build settings",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "period": {
      "type": "string",
      "description": "Time window for the first fetch. Required when `from_line` is not sent.",
      "enum": [
        "1h",
        "1d",
        "1w",
        "1m"
      ]
    },
    "from_line": {
      "type": "integer",
      "description": "1-based line of the log file to start from. For polling send `total_lines + 1` from the\nprevious response. Cannot be combined with `period`."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of log entries to return. When more entries match, the newest are kept."
    },
    "levels": {
      "type": "array",
      "description": "Return only entries with these log levels, sent as a comma-separated list, e.g. ERROR,WARN.\nMatching runs on the raw log line, so entries written with numeric levels (for example by\npino) are excluded while this filter is set.",
      "items": {
        "type": "string",
        "description": "levels parameter",
        "enum": [
          "LOG",
          "ERROR",
          "WARN",
          "INFO",
          "DEBUG",
          "TRACE"
        ]
      }
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Get Node.js runtime logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "uuid": {
      "type": "string",
      "description": "Build UUID"
    },
    "from_line": {
      "type": "integer",
      "description": "Line from which to start retrieving logs"
    }
  },
  "required": [
    "username",
    "domain",
    "uuid"
  ]
}

{
  "title": "Get NodeJS build logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Get PHP details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Get PHP info",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "name": {
      "type": "string",
      "description": "Full database name as returned by the list databases endpoint."
    }
  },
  "required": [
    "username",
    "name"
  ]
}

{
  "title": "Get phpMyAdmin link",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "path": {
      "type": "string",
      "description": "File path, relative to the document root."
    },
    "from_line": {
      "type": "integer",
      "description": "Line offset to start reading from."
    },
    "max_lines": {
      "type": "integer",
      "description": "Max number of lines to return."
    }
  },
  "required": [
    "username",
    "domain",
    "path"
  ]
}

{
  "title": "Get website file content",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name associated with the hosting account (e.g., example.com)"
    },
    "archivePath": {
      "type": "string",
      "description": "Absolute or relative path to the website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mywebsite_20250115_143022.zip)"
    },
    "databaseDump": {
      "type": "string",
      "description": "Absolute or relative path to a database dump file (.sql)"
    }
  },
  "required": [
    "domain",
    "archivePath",
    "databaseDump"
  ]
}

{
  "title": "Import WordPress website",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "archive_path": {
      "type": "string",
      "description": "Path to the WordPress archive file (relative to website root)"
    },
    "sql_path": {
      "type": "string",
      "description": "Path to the database SQL file (relative to website root)"
    }
  },
  "required": [
    "username",
    "domain",
    "archive_path",
    "sql_path"
  ]
}

{
  "title": "Import WordPress website",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "plugins": {
      "type": "array",
      "description": "Plugin slugs to install. Use GET /api/hosting/v1/wordpress/plugins to discover available slugs.",
      "items": {
        "type": "string",
        "description": "Plugin slug"
      }
    }
  },
  "required": [
    "username",
    "software",
    "plugins"
  ]
}

{
  "title": "Install WordPress plugins",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "theme": {
      "type": "string",
      "description": "Slug of the theme to install. Hostinger theme slugs (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme) trigger the custom installer and forward the optional palette/layout/font fields; any other WordPress theme slug uses the standard installer and ignores those fields."
    },
    "palette": {
      "type": "string",
      "description": "Palette identifier. Only applied when the theme is a Hostinger theme; the default is used when omitted."
    },
    "layout": {
      "type": "string",
      "description": "Layout identifier. Only applied when the theme is a Hostinger theme; the default is used when omitted."
    },
    "font": {
      "type": "string",
      "description": "Font identifier. Only applied when the theme is a Hostinger theme; the default is used when omitted.",
      "enum": [
        "professional",
        "modern",
        "elegant",
        "creative",
        "dynamic",
        "default"
      ]
    }
  },
  "required": [
    "username",
    "software",
    "theme"
  ]
}

{
  "title": "Install WordPress theme",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain of the existing website where WordPress will be installed"
    },
    "site_title": {
      "type": "string",
      "description": "Title of the WordPress site"
    },
    "language": {
      "type": "string",
      "description": "WordPress locale. Defaults to en_US when omitted."
    },
    "directory": {
      "type": "string",
      "description": "Relative directory to install WordPress into. Defaults to the website root when omitted."
    },
    "overwrite": {
      "type": "boolean",
      "description": "When false (default), does not replace an existing installation. If WordPress is already installed on the domain/path, the async install job fails unless true."
    },
    "auto_updates": {
      "type": "string",
      "description": "WordPress core auto-update policy",
      "enum": [
        "all",
        "none",
        "minor"
      ]
    },
    "version": {
      "type": "string",
      "description": "WordPress core version to install. If omitted, the latest core version compatible with the account vhost PHP version is selected."
    },
    "credentials": {
      "type": "object",
      "description": "WordPress admin credentials",
      "properties": {
        "email": {
          "type": "string",
          "description": "email parameter"
        },
        "login": {
          "type": "string",
          "description": "WordPress admin username"
        },
        "password": {
          "type": "string",
          "description": "password parameter"
        }
      },
      "required": [
        "email",
        "login",
        "password"
      ]
    },
    "database": {
      "type": "object",
      "description": "Optional. If the named database already exists, it will be used for this WordPress install. Otherwise a new database is created with a generated name and random credentials.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Database name (username prefix added if missing)"
        },
        "password": {
          "type": "string",
          "description": "password parameter"
        }
      }
    }
  },
  "required": [
    "username",
    "domain",
    "site_title",
    "credentials"
  ]
}

{
  "title": "Install WordPress",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    }
  },
  "required": [
    "username"
  ]
}

{
  "title": "List account cron jobs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    },
    "domain": {
      "type": "string",
      "description": "Filter by domain name (case-insensitive substring match)"
    },
    "is_assigned": {
      "type": "boolean",
      "description": "When used with domain, return only databases assigned to that domain."
    },
    "search": {
      "type": "string",
      "description": "Search databases by name, user, or creation date."
    }
  },
  "required": [
    "username"
  ]
}

{
  "title": "List account databases",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "Order ID"
    }
  },
  "required": [
    "order_id"
  ]
}

{
  "title": "List available datacenters",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "List available WordPress core updates",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "List available WordPress plugins",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Filter remote connections by the domain the database is assigned to.\nRules for databases not assigned to any domain are always included."
    }
  },
  "required": [
    "username"
  ]
}

{
  "title": "List database remote connections",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "category": {
      "type": "string",
      "description": "Filter installed plugins by category.",
      "enum": [
        "cache"
      ]
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "List installed WordPress plugins",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "List installed WordPress themes",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name associated with the hosting account (e.g., example.com)"
    },
    "page": {
      "type": "integer",
      "description": "Page number for pagination (optional)"
    },
    "perPage": {
      "type": "integer",
      "description": "Number of items per page (optional)"
    },
    "states": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "pending",
          "completed",
          "running",
          "failed"
        ]
      },
      "description": "Filter by deployment states (optional). Valid values: pending, completed, running, failed"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "List JavaScript deployments",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "List Node.js environment variables",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "severities": {
      "type": "array",
      "description": "Severities to filter by",
      "items": {
        "type": "string",
        "description": "severities parameter",
        "enum": [
          "low",
          "moderate",
          "high",
          "critical",
          "unknown"
        ]
      }
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "List Node.js vulnerabilities",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    },
    "states": {
      "type": "array",
      "description": "Build states to filter by",
      "items": {
        "type": "string",
        "description": "states parameter",
        "enum": [
          "pending",
          "running",
          "completed",
          "failed"
        ]
      }
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "List NodeJS builds",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    },
    "statuses": {
      "type": "array",
      "description": "Filter by order statuses",
      "items": {
        "type": "string",
        "description": "statuses parameter",
        "enum": [
          "active",
          "deleting",
          "deleted",
          "suspended"
        ]
      }
    },
    "order_ids": {
      "type": "array",
      "description": "Filter by specific order IDs",
      "items": {
        "type": "integer",
        "description": "order_ids parameter"
      }
    }
  },
  "required": []
}

{
  "title": "List orders",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "Optionally scope suggestions to a specific order."
    }
  },
  "required": []
}

{
  "title": "List suggested WordPress plugins",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "directory": {
      "type": "string",
      "description": "Directory path to check"
    },
    "max_depth": {
      "type": "integer",
      "description": "How many directory levels deep to recurse."
    },
    "max_items": {
      "type": "integer",
      "description": "Max number of entries to return in this page."
    },
    "offset": {
      "type": "integer",
      "description": "Number of entries to skip. Page with offset + item count until reaching total_items."
    },
    "file_types": {
      "type": "array",
      "description": "Filter by entry type, e.g. file,directory. Omit for all types.",
      "items": {
        "type": "string",
        "description": "file_types parameter",
        "enum": [
          "file",
          "directory",
          "symlink",
          "other"
        ]
      }
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "List website files and directories",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "List website parked domains",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "List website redirects",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "List website subdomains",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    },
    "username": {
      "type": "string",
      "description": "Filter by specific username"
    },
    "order_id": {
      "type": "integer",
      "description": "Order ID"
    },
    "is_enabled": {
      "type": "boolean",
      "description": "Filter by enabled status"
    },
    "domain": {
      "type": "string",
      "description": "Filter by domain name (case-insensitive substring match)"
    },
    "website_types": {
      "type": "array",
      "description": "Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.",
      "items": {
        "type": "string",
        "description": "website_types parameter",
        "enum": [
          "wordpress",
          "builder",
          "horizons",
          "nodejs",
          "other"
        ]
      }
    }
  },
  "required": []
}

{
  "title": "List websites",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "Filter by specific username"
    },
    "domain": {
      "type": "string",
      "description": "Filter by domain name (case-insensitive substring match)"
    },
    "ownership": {
      "type": "string",
      "description": "Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.",
      "enum": [
        "owned",
        "managed",
        "all"
      ]
    }
  },
  "required": []
}

{
  "title": "List WordPress installations",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "description": "Optionally scope themes to a specific order."
    },
    "search": {
      "type": "string",
      "description": "Search term to match against theme names."
    }
  },
  "required": []
}

{
  "title": "List WordPress themes",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "vulnerability_ids": {
      "type": "array",
      "description": "List of vulnerability IDs to patch, as returned by the list vulnerabilities endpoint.",
      "items": {
        "type": "string",
        "description": "vulnerability_ids parameter"
      }
    }
  },
  "required": [
    "username",
    "domain",
    "vulnerability_ids"
  ]
}

{
  "title": "Patch Node.js vulnerabilities",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Purge LiteSpeed Cache",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "name": {
      "type": "string",
      "description": "Full database name as returned by the list databases endpoint."
    }
  },
  "required": [
    "username",
    "name"
  ]
}

{
  "title": "Repair database",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "env_vars": {
      "type": "array",
      "description": "Environment variables to set. This is the full desired set: any variable not in\nthis list is deleted, and an empty array deletes every variable.",
      "items": {
        "type": "object",
        "description": "env_vars parameter",
        "properties": {
          "key": {
            "type": "string",
            "description": "Environment variable name. Must start with an uppercase letter or\nunderscore, followed by uppercase letters, digits or underscores."
          },
          "value": {
            "type": "string",
            "description": "Environment variable value."
          }
        },
        "required": [
          "key",
          "value"
        ]
      }
    }
  },
  "required": [
    "username",
    "domain",
    "env_vars"
  ]
}

{
  "title": "Replace Node.js environment variables",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Reset PHP extensions",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Restart Node.js application",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "search": {
      "type": "string",
      "description": "Search term to match against plugin names. Minimum 3 characters."
    }
  },
  "required": [
    "search"
  ]
}

{
  "title": "Search WordPress plugins",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "option": {
      "type": "string",
      "description": "AI option name",
      "enum": [
        "llmstxt",
        "web2agent"
      ]
    },
    "enable": {
      "type": "boolean",
      "description": "Enable (true) or disable (false) the AI option."
    }
  },
  "required": [
    "username",
    "software",
    "option",
    "enable"
  ]
}

{
  "title": "Set AI option status",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "option": {
      "type": "string",
      "description": "Filter the status by a single AI option.",
      "enum": [
        "llmstxt",
        "web2agent"
      ]
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Show AI option status",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain name associated with the hosting account (e.g., example.com)"
    },
    "fromLine": {
      "type": "integer",
      "description": "Line from which to retrieve logs (optional, default 0)"
    },
    "buildUuid": {
      "type": "string",
      "description": "UUID of the JavaScript deployment build"
    }
  },
  "required": [
    "domain",
    "buildUuid"
  ]
}

{
  "title": "Show JavaScript deployment logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Show LiteSpeed Cache status",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Show maintenance status",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Show Memcached object cache status",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Show WordPress core version",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "node_version": {
      "type": "integer",
      "description": "Node.js version",
      "enum": [
        18,
        20,
        22,
        24
      ]
    },
    "app_type": {
      "type": "string",
      "description": "Node.js application type",
      "enum": [
        "create-react-app",
        "gatsby",
        "vite",
        "angular",
        "react",
        "vue",
        "parcel",
        "next",
        "nuxt",
        "nest",
        "express",
        "fastify",
        "astro",
        "svelte",
        "svelte-kit",
        "hono",
        "react-router",
        "nitro",
        "other"
      ]
    },
    "root_directory": {
      "type": "string",
      "description": "Application root directory (where package.json is located) relative to public_html"
    },
    "output_directory": {
      "type": "string",
      "description": "Build output directory relative to the root directory"
    },
    "build_script": {
      "type": "string",
      "description": "Build script that will be ran to build the application"
    },
    "entry_file": {
      "type": "string",
      "description": "The main entry point file for the application"
    },
    "package_manager": {
      "type": "string",
      "description": "Package manager",
      "enum": [
        "npm",
        "yarn",
        "pnpm"
      ]
    },
    "source_type": {
      "type": "string",
      "description": "The source type of the files",
      "enum": [
        "archive"
      ]
    },
    "source_options": {
      "type": "object",
      "description": "Source-specific options",
      "properties": {
        "archive_path": {
          "type": "string",
          "description": "The path to the archive file relative to the document root of the vhost (required if source is \"archive\")"
        }
      }
    }
  },
  "required": [
    "username",
    "domain",
    "node_version",
    "app_type",
    "root_directory",
    "output_directory",
    "build_script",
    "source_type",
    "source_options"
  ]
}

{
  "title": "Start Node.js build",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "enabled": {
      "type": "boolean",
      "description": "Turn development (cacheless) mode on (true) or off (false) for the website."
    }
  },
  "required": [
    "username",
    "domain",
    "enabled"
  ]
}

{
  "title": "Toggle cacheless mode",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "enabled": {
      "type": "boolean",
      "description": "Enable (true) or disable (false) maintenance mode for the WordPress installation."
    }
  },
  "required": [
    "username",
    "software",
    "enabled"
  ]
}

{
  "title": "Toggle maintenance mode",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "enabled": {
      "type": "boolean",
      "description": "Activate (true) or deactivate (false) the Memcached object cache for the WordPress installation."
    }
  },
  "required": [
    "username",
    "software",
    "enabled"
  ]
}

{
  "title": "Toggle Memcached object cache",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "enabled": {
      "type": "boolean",
      "description": "Turn server-side caching on (true) or off (false) for the website."
    }
  },
  "required": [
    "username",
    "domain",
    "enabled"
  ]
}

{
  "title": "Toggle website cache",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "plugins": {
      "type": "array",
      "description": "Slugs of the installed plugins to uninstall.",
      "items": {
        "type": "string",
        "description": "Plugin slug"
      }
    }
  },
  "required": [
    "username",
    "software",
    "plugins"
  ]
}

{
  "title": "Uninstall WordPress plugins",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "themes": {
      "type": "array",
      "description": "Slugs of the installed themes to uninstall.",
      "items": {
        "type": "string",
        "description": "Theme slug"
      }
    }
  },
  "required": [
    "username",
    "software",
    "themes"
  ]
}

{
  "title": "Uninstall WordPress themes",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "slug": {
      "type": "string",
      "description": "Slug of the Hostinger plugin to update to its latest version.",
      "enum": [
        "hostinger",
        "hostinger-ai-assistant",
        "hostinger-affiliate-plugin",
        "hostinger-easy-onboarding",
        "hostinger-reach"
      ]
    }
  },
  "required": [
    "username",
    "software",
    "slug"
  ]
}

{
  "title": "Update Hostinger WordPress plugin",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "node_version": {
      "type": "integer",
      "description": "Node.js major version",
      "enum": [
        18,
        20,
        22,
        24
      ]
    },
    "app_type": {
      "type": "string",
      "description": "Node.js application framework. Set it explicitly when auto-detection picked the wrong one.",
      "enum": [
        "create-react-app",
        "gatsby",
        "vite",
        "angular",
        "react",
        "vue",
        "parcel",
        "next",
        "nuxt",
        "nest",
        "express",
        "fastify",
        "astro",
        "svelte",
        "svelte-kit",
        "hono",
        "react-router",
        "nitro",
        "other"
      ]
    },
    "root_directory": {
      "type": "string",
      "description": "Application root directory (where package.json is located) relative to public_html.\nOmit it, or send \".\", for public_html itself."
    },
    "output_directory": {
      "type": "string",
      "description": "Build output directory relative to the root directory"
    },
    "build_script": {
      "type": "string",
      "description": "The package.json script that builds the application"
    },
    "entry_file": {
      "type": "string",
      "description": "The main entry point file for the application\n(required for express, fastify, nest, nuxt and hono app types)"
    },
    "package_manager": {
      "type": "string",
      "description": "Package manager used to install dependencies",
      "enum": [
        "npm",
        "yarn",
        "pnpm"
      ]
    }
  },
  "required": [
    "username",
    "domain",
    "node_version"
  ]
}

{
  "title": "Update Node.js build settings",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "enable": {
      "type": "array",
      "description": "PHP extensions to enable.",
      "items": {
        "type": "string",
        "description": "enable parameter"
      }
    },
    "disable": {
      "type": "array",
      "description": "PHP extensions to disable.",
      "items": {
        "type": "string",
        "description": "disable parameter"
      }
    }
  },
  "required": [
    "username",
    "domain"
  ]
}

{
  "title": "Update PHP extensions",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "options": {
      "type": "object",
      "description": "Map of PHP options to update, keyed by option name. Only include options you want to change.",
      "properties": {}
    }
  },
  "required": [
    "username",
    "domain",
    "options"
  ]
}

{
  "title": "Update PHP options",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "domain": {
      "type": "string",
      "description": "Domain name"
    },
    "version": {
      "type": "string",
      "description": "PHP version to switch the website to."
    }
  },
  "required": [
    "username",
    "domain",
    "version"
  ]
}

{
  "title": "Update PHP version",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "minor": {
      "type": "boolean",
      "description": "Update the minor version only."
    },
    "version": {
      "type": "string",
      "description": "Update to a specific WordPress core version."
    }
  },
  "required": [
    "username",
    "software"
  ]
}

{
  "title": "Update WordPress core",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "plugins": {
      "type": "array",
      "description": "Slugs of the installed plugins to update to their latest version.",
      "items": {
        "type": "string",
        "description": "Plugin slug"
      }
    }
  },
  "required": [
    "username",
    "software",
    "plugins"
  ]
}

{
  "title": "Update WordPress plugins",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "username parameter"
    },
    "software": {
      "type": "string",
      "description": "WordPress installation (software) identifier"
    },
    "themes": {
      "type": "array",
      "description": "Slugs of the installed themes to update to their latest version.",
      "items": {
        "type": "string",
        "description": "Theme slug"
      }
    }
  },
  "required": [
    "username",
    "software",
    "themes"
  ]
}

{
  "title": "Update WordPress themes",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Domain to verify ownership for"
    }
  },
  "required": [
    "domain"
  ]
}

{
  "title": "Verify domain ownership",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "mailboxId": {
      "type": "string",
      "description": "Mailbox resource ID"
    },
    "password": {
      "type": "string",
      "description": "New mailbox password. Minimum 8 characters with uppercase, lowercase, number and special character; must not be a commonly used password."
    }
  },
  "required": [
    "mailboxId",
    "password"
  ]
}

{
  "title": "Change mailbox password",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "mailboxId": {
      "type": "string",
      "description": "Mailbox resource ID"
    },
    "local_part": {
      "type": "string",
      "description": "Local part of the alias address (the part before the @). The domain is taken from the mailbox. Case-insensitive and stored lowercase; must start and end with a letter or digit; single dots, underscores and hyphens are allowed in between."
    }
  },
  "required": [
    "mailboxId",
    "local_part"
  ]
}

{
  "title": "Create alias",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "name": {
      "type": "string",
      "description": "Human-readable label for this token"
    },
    "scope": {
      "type": "object",
      "description": "Mailbox scope this token can access",
      "properties": {
        "has_all_mailboxes": {
          "type": "boolean",
          "description": "Grant access to all current and future mailboxes of the order"
        },
        "mailbox_ids": {
          "type": "array",
          "description": "Required when `has_all_mailboxes` is false. Mailbox resource IDs of this order.",
          "items": {
            "type": "string",
            "description": "mailbox_ids parameter"
          }
        }
      },
      "required": [
        "has_all_mailboxes"
      ]
    }
  },
  "required": [
    "orderId",
    "name",
    "scope"
  ]
}

{
  "title": "Create API token",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "mailboxId": {
      "type": "string",
      "description": "Mailbox resource ID"
    },
    "subject": {
      "type": "string",
      "description": "Subject of the automatic reply"
    },
    "body": {
      "type": "string",
      "description": "Body of the automatic reply"
    },
    "display_name": {
      "type": "string",
      "description": "Sender display name used for the reply"
    },
    "starts_at": {
      "type": "string",
      "description": "When the autoreply becomes active. Defaults to now."
    },
    "ends_at": {
      "type": "string",
      "description": "When the autoreply stops. Omit for an indefinite autoreply."
    }
  },
  "required": [
    "mailboxId",
    "subject",
    "body"
  ]
}

{
  "title": "Create autoreply",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "mailboxId": {
      "type": "string",
      "description": "Mailbox resource ID"
    }
  },
  "required": [
    "mailboxId"
  ]
}

{
  "title": "Create catch-all",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "mailboxId": {
      "type": "string",
      "description": "Mailbox resource ID"
    },
    "destination": {
      "type": "string",
      "description": "Email address the messages will be forwarded to"
    },
    "is_keep_copy_enabled": {
      "type": "boolean",
      "description": "Whether to keep a copy of forwarded messages in the mailbox. Defaults to false."
    }
  },
  "required": [
    "mailboxId",
    "destination"
  ]
}

{
  "title": "Create forwarder",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "local_part": {
      "type": "string",
      "description": "Local part of the mailbox address (the part before the @). The domain is taken from the order. Must start and end with a letter or digit; single dots, underscores and hyphens are allowed in between."
    },
    "password": {
      "type": "string",
      "description": "Mailbox password. Minimum 8 characters with uppercase, lowercase, number and special character."
    }
  },
  "required": [
    "orderId",
    "local_part",
    "password"
  ]
}

{
  "title": "Create mailbox",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "mailboxId": {
      "type": "string",
      "description": "Mailbox resource ID"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for this webhook"
    },
    "description": {
      "type": "string",
      "description": "Optional description of the webhook's purpose"
    },
    "events": {
      "type": "array",
      "description": "Events that trigger this webhook",
      "items": {
        "type": "string",
        "description": "events parameter",
        "enum": [
          "message.received"
        ]
      }
    },
    "status": {
      "type": "string",
      "description": "Initial status of the webhook",
      "enum": [
        "active",
        "disabled",
        "paused"
      ]
    },
    "url": {
      "type": "string",
      "description": "Publicly reachable URL that receives the webhook POST requests"
    }
  },
  "required": [
    "mailboxId",
    "name",
    "events",
    "url"
  ]
}

{
  "title": "Create webhook",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "aliasId": {
      "type": "string",
      "description": "Alias resource ID"
    }
  },
  "required": [
    "aliasId"
  ]
}

{
  "title": "Delete alias",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "autoreplyId": {
      "type": "string",
      "description": "Autoreply resource ID"
    }
  },
  "required": [
    "autoreplyId"
  ]
}

{
  "title": "Delete autoreply",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "catchallId": {
      "type": "string",
      "description": "Catch-all resource ID"
    }
  },
  "required": [
    "catchallId"
  ]
}

{
  "title": "Delete catch-all",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "forwarderId": {
      "type": "string",
      "description": "Forwarder resource ID"
    }
  },
  "required": [
    "forwarderId"
  ]
}

{
  "title": "Delete forwarder",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "mailboxId": {
      "type": "string",
      "description": "Mailbox resource ID"
    }
  },
  "required": [
    "mailboxId"
  ]
}

{
  "title": "Delete mailbox",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "webhookId": {
      "type": "string",
      "description": "Webhook ID (returned when the webhook was created)"
    }
  },
  "required": [
    "webhookId"
  ]
}

{
  "title": "Delete webhook",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "Get order plan",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "webhookId": {
      "type": "string",
      "description": "Webhook ID (returned when the webhook was created)"
    }
  },
  "required": [
    "webhookId"
  ]
}

{
  "title": "Get webhook",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "account": {
      "type": "string",
      "description": "Filter log entries by a specific email account"
    },
    "date": {
      "type": "string",
      "description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
    },
    "from_date": {
      "type": "string",
      "description": "Date range start (RFC 3339)"
    },
    "to_date": {
      "type": "string",
      "description": "Date range end (RFC 3339)"
    },
    "status": {
      "type": "string",
      "description": "Filter log entries by status",
      "enum": [
        "Successful",
        "Failed"
      ]
    },
    "protocol": {
      "type": "string",
      "description": "Filter access log entries by protocol",
      "enum": [
        "imap",
        "pop3",
        "smtp"
      ]
    },
    "has_deletions": {
      "type": "boolean",
      "description": "Filter access log entries by whether the session had deletions"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List access logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "account": {
      "type": "string",
      "description": "Filter log entries by a specific email account"
    },
    "date": {
      "type": "string",
      "description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
    },
    "from_date": {
      "type": "string",
      "description": "Date range start (RFC 3339)"
    },
    "to_date": {
      "type": "string",
      "description": "Date range end (RFC 3339)"
    },
    "status": {
      "type": "string",
      "description": "Filter log entries by status",
      "enum": [
        "Successful",
        "Failed"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List action logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List aliases",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "description": "Filter tokens by order resource ID. Single value or comma-separated list."
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": []
}

{
  "title": "List API tokens",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List autoreplies",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List catch-alls",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List forwarders",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "account": {
      "type": "string",
      "description": "Filter log entries by a specific email account"
    },
    "date": {
      "type": "string",
      "description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
    },
    "from_date": {
      "type": "string",
      "description": "Date range start (RFC 3339)"
    },
    "to_date": {
      "type": "string",
      "description": "Date range end (RFC 3339)"
    },
    "status": {
      "type": "string",
      "description": "Filter log entries by status",
      "enum": [
        "Successful",
        "Failed"
      ]
    },
    "sender": {
      "type": "string",
      "description": "Filter log entries by sender. Accepts a full email address or a domain."
    },
    "recipient": {
      "type": "string",
      "description": "Filter log entries by recipient. Accepts a full email address or a domain."
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List inbound logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "email": {
      "type": "string",
      "description": "Mailbox email address. Must belong to the order's domain."
    },
    "date": {
      "type": "string",
      "description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
    },
    "from_date": {
      "type": "string",
      "description": "Date range start (RFC 3339)"
    },
    "to_date": {
      "type": "string",
      "description": "Date range end (RFC 3339)"
    },
    "event": {
      "type": "string",
      "description": "Filter mailbox action log entries by event type",
      "enum": [
        "MessageNew",
        "MessageRead",
        "MessageAppend",
        "MessageExpunge",
        "MailboxCreate",
        "MailboxDelete",
        "MailboxRename"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId",
    "email"
  ]
}

{
  "title": "List mailbox action logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "search": {
      "type": "string",
      "description": "Filter mailboxes whose email address contains the given string"
    },
    "sort": {
      "type": "string",
      "description": "Sort mailboxes by field. Prefix with `-` for descending order.",
      "enum": [
        "address",
        "-address"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List mailboxes",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Filter orders by domain name (exact match)"
    },
    "status": {
      "type": "string",
      "description": "Filter orders by status",
      "enum": [
        "pending_setup",
        "active",
        "suspended"
      ]
    },
    "is_trial": {
      "type": "boolean",
      "description": "Filter orders by trial state"
    },
    "sort": {
      "type": "string",
      "description": "Sort orders by field. Prefix with `-` for descending order.",
      "enum": [
        "created_at",
        "-created_at",
        "expires_at",
        "-expires_at"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": []
}

{
  "title": "List orders",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "account": {
      "type": "string",
      "description": "Filter log entries by a specific email account"
    },
    "date": {
      "type": "string",
      "description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
    },
    "from_date": {
      "type": "string",
      "description": "Date range start (RFC 3339)"
    },
    "to_date": {
      "type": "string",
      "description": "Date range end (RFC 3339)"
    },
    "status": {
      "type": "string",
      "description": "Filter log entries by status",
      "enum": [
        "Successful",
        "Failed"
      ]
    },
    "sender": {
      "type": "string",
      "description": "Filter log entries by sender. Accepts a full email address or a domain."
    },
    "recipient": {
      "type": "string",
      "description": "Filter log entries by recipient. Accepts a full email address or a domain."
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List outbound logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "mailbox_id": {
      "type": "string",
      "description": "Filter by the mailbox resource ID the webhooks are attached to"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List webhook delivery logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order resource ID"
    },
    "mailbox_id": {
      "type": "string",
      "description": "Filter by the mailbox resource ID the webhooks are attached to"
    },
    "status": {
      "type": "string",
      "description": "Filter webhooks by status",
      "enum": [
        "active",
        "disabled",
        "paused"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "orderId"
  ]
}

{
  "title": "List webhooks",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "webhookId": {
      "type": "string",
      "description": "Webhook ID (returned when the webhook was created)"
    }
  },
  "required": [
    "webhookId"
  ]
}

{
  "title": "Regenerate webhook secret",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "catchallId": {
      "type": "string",
      "description": "Catch-all resource ID"
    }
  },
  "required": [
    "catchallId"
  ]
}

{
  "title": "Resend catch-all confirmation",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "forwarderId": {
      "type": "string",
      "description": "Forwarder resource ID"
    }
  },
  "required": [
    "forwarderId"
  ]
}

{
  "title": "Resend forwarder confirmation",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "tokenId": {
      "type": "string",
      "description": "API token ID (returned when the token was created)"
    }
  },
  "required": [
    "tokenId"
  ]
}

{
  "title": "Revoke API token",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "webhookId": {
      "type": "string",
      "description": "Webhook ID (returned when the webhook was created)"
    }
  },
  "required": [
    "webhookId"
  ]
}

{
  "title": "Test webhook",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "autoreplyId": {
      "type": "string",
      "description": "Autoreply resource ID"
    },
    "subject": {
      "type": "string",
      "description": "Subject of the automatic reply"
    },
    "body": {
      "type": "string",
      "description": "Body of the automatic reply"
    },
    "display_name": {
      "type": "string",
      "description": "Sender display name used for the reply"
    },
    "starts_at": {
      "type": "string",
      "description": "When the autoreply becomes active. Defaults to now."
    },
    "ends_at": {
      "type": "string",
      "description": "When the autoreply stops. Omit for an indefinite autoreply."
    }
  },
  "required": [
    "autoreplyId",
    "subject",
    "body"
  ]
}

{
  "title": "Update autoreply",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "forwarderId": {
      "type": "string",
      "description": "Forwarder resource ID"
    },
    "is_keep_copy_enabled": {
      "type": "boolean",
      "description": "Whether to keep a copy of forwarded messages in the mailbox"
    }
  },
  "required": [
    "forwarderId",
    "is_keep_copy_enabled"
  ]
}

{
  "title": "Update forwarder keep-copy setting",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "webhookId": {
      "type": "string",
      "description": "Webhook ID (returned when the webhook was created)"
    },
    "name": {
      "type": "string",
      "description": "New human-readable name for the webhook"
    },
    "description": {
      "type": "string",
      "description": "New description, or null to clear it"
    },
    "events": {
      "type": "array",
      "description": "Replaces the full list of subscribed events",
      "items": {
        "type": "string",
        "description": "events parameter",
        "enum": [
          "message.received"
        ]
      }
    },
    "status": {
      "type": "string",
      "description": "New status for the webhook",
      "enum": [
        "active",
        "disabled",
        "paused"
      ]
    },
    "url": {
      "type": "string",
      "description": "New URL to deliver events to"
    }
  },
  "required": [
    "webhookId"
  ]
}

{
  "title": "Update webhook",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "tagUuid": {
      "type": "string",
      "description": "Tag uuid parameter"
    },
    "contactUuid": {
      "type": "string",
      "description": "Contact uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "tagUuid",
    "contactUuid"
  ]
}

{
  "title": "Assign a contact to a tag",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "tagUuid": {
      "type": "string",
      "description": "Tag uuid parameter"
    },
    "contact_uuids": {
      "type": "array",
      "description": "Contacts to apply the change to. Required unless all_contacts is true.",
      "items": {
        "type": "string",
        "description": "contact_uuids parameter"
      }
    },
    "all_contacts": {
      "type": "boolean",
      "description": "Apply to every contact in the profile"
    }
  },
  "required": [
    "profileUuid",
    "tagUuid"
  ]
}

{
  "title": "Assign contacts to a tag",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "segmentUuid": {
      "type": "string",
      "description": "Segment uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "segmentUuid"
  ]
}

{
  "title": "Count profile segment contacts",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "type": {
      "type": "string",
      "description": "Immutable once the field exists",
      "enum": [
        "text",
        "number",
        "date",
        "single_choice",
        "multi_choice"
      ]
    },
    "label": {
      "type": "string",
      "description": "label parameter"
    },
    "options": {
      "type": "array",
      "description": "Required for single_choice and multi_choice, ignored for the scalar types. Labels must be unique regardless of casing.",
      "items": {
        "type": "string",
        "description": "options parameter"
      }
    }
  },
  "required": [
    "profileUuid",
    "type",
    "label"
  ]
}

{
  "title": "Create a contact field",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "sender_name": {
      "type": "string",
      "description": "From name shown to the recipients."
    },
    "sender_email": {
      "type": "string",
      "description": "From address of the campaign. Its domain has to be verified on the profile before\nthe campaign can be sent."
    },
    "title": {
      "type": "string",
      "description": "Name the campaign is listed under. Not shown to the recipients."
    },
    "subject": {
      "type": "string",
      "description": "Subject line of the email."
    },
    "template_uuid": {
      "type": "string",
      "description": "Template to send, as returned by the template endpoints. Can be left out and\nattached later, but the campaign cannot be sent without one."
    },
    "metadata": {
      "type": "object",
      "description": "Extra campaign fields. Any key outside the listed ones is rejected.",
      "properties": {
        "preheader": {
          "type": "string",
          "description": "Preview text shown after the subject line in the inbox."
        },
        "source": {
          "type": "string",
          "description": "Where the campaign was created from."
        }
      }
    }
  },
  "required": [
    "profileUuid",
    "sender_name",
    "sender_email"
  ]
}

{
  "title": "Create a draft campaign",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "template_content": {
      "type": "string",
      "description": "The email body as HTML. It is sanitised before it is stored, so the saved template\ncan differ from what was sent - inline any styles the email clients need and keep\nthe markup self-contained."
    },
    "title": {
      "type": "string",
      "description": "Name the template is listed under. Not shown to the recipients."
    }
  },
  "required": [
    "profileUuid",
    "template_content"
  ]
}

{
  "title": "Create an email template",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "name parameter"
    },
    "conditions": {
      "type": "array",
      "description": "conditions parameter",
      "items": {
        "type": "object",
        "description": "conditions parameter",
        "properties": {
          "operator": {
            "type": "string",
            "description": "operator parameter",
            "enum": [
              "equals",
              "not_equals",
              "contains",
              "not_contains",
              "gte",
              "lte",
              "exists",
              "within_last_days",
              "not_within_last_days",
              "older_than_days",
              "processed",
              "not_processed",
              "delivered",
              "not_delivered",
              "dropped",
              "not_dropped",
              "bounced",
              "not_bounced",
              "soft_bounced",
              "not_soft_bounced",
              "opened",
              "not_opened",
              "clicked",
              "not_clicked",
              "unsubscribed",
              "not_unsubscribed"
            ]
          },
          "value": {
            "type": "string",
            "description": "value parameter"
          },
          "attribute": {
            "type": "string",
            "description": "attribute parameter",
            "enum": [
              "note",
              "comment",
              "domain",
              "integration",
              "source",
              "name",
              "surname",
              "email",
              "subscribed_at",
              "unsubscribed_at",
              "subscription_status",
              "processed",
              "opened",
              "clicked",
              "delivered",
              "bounced",
              "unsubscribed",
              "dropped",
              "tag",
              "campaigns"
            ]
          }
        }
      }
    },
    "logic": {
      "type": "string",
      "description": "logic parameter",
      "enum": [
        "AND",
        "OR"
      ]
    }
  },
  "required": [
    "name",
    "conditions",
    "logic"
  ]
}

{
  "title": "Create a new contact segment",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "email parameter"
    },
    "name": {
      "type": "string",
      "description": "name parameter"
    },
    "surname": {
      "type": "string",
      "description": "surname parameter"
    },
    "phone": {
      "type": "string",
      "description": "Phone number in E.164 format (leading \"+\" then 7-15 digits)"
    },
    "note": {
      "type": "string",
      "description": "note parameter"
    },
    "tag_uuids": {
      "type": "array",
      "description": "Existing tags to attach to the created contact",
      "items": {
        "type": "string",
        "description": "tag_uuids parameter"
      }
    }
  },
  "required": [
    "email"
  ]
}

{
  "title": "Create a new contact",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "name": {
      "type": "string",
      "description": "name parameter"
    },
    "conditions": {
      "type": "array",
      "description": "Conditions a contact must satisfy to fall into the segment",
      "items": {
        "type": "object",
        "description": "conditions parameter",
        "properties": {
          "attribute": {
            "type": "string",
            "description": "A built-in contact attribute, or `cf:{fieldUuid}` to target a custom\ncontact field. Custom fields are addressed by field UUID; their slug\nis not accepted.\n\nBuilt-in attributes: `email`, `note`, `domain`, `source`,\n`opt_in_method`, `subscription_status`, `subscribed_at`,\n`unsubscribed_at`, `created_at`, `tag`, `campaigns`, `processed`,\n`opened`, `clicked`, `delivered`, `bounced`, `soft_bounced`,\n`dropped`.\n\nWhich operators are accepted depends on the attribute."
          },
          "operator": {
            "type": "string",
            "description": "operator parameter",
            "enum": [
              "equals",
              "not_equals",
              "contains",
              "not_contains",
              "gte",
              "lte",
              "exists",
              "within_last_days",
              "not_within_last_days",
              "older_than_days",
              "processed",
              "not_processed",
              "delivered",
              "not_delivered",
              "dropped",
              "not_dropped",
              "bounced",
              "not_bounced",
              "soft_bounced",
              "not_soft_bounced",
              "opened",
              "not_opened",
              "clicked",
              "not_clicked",
              "unsubscribed",
              "not_unsubscribed"
            ]
          },
          "value": {
            "type": "string",
            "description": "Always a string, including for numeric and date comparisons"
          }
        },
        "required": [
          "attribute",
          "operator",
          "value"
        ]
      }
    },
    "logic": {
      "type": "string",
      "description": "How to combine multiple conditions",
      "enum": [
        "AND",
        "OR"
      ]
    }
  },
  "required": [
    "profileUuid",
    "name",
    "conditions",
    "logic"
  ]
}

{
  "title": "Create a profile segment",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "contacts": {
      "type": "array",
      "description": "contacts parameter",
      "items": {
        "type": "object",
        "description": "contacts parameter",
        "properties": {
          "email": {
            "type": "string",
            "description": "email parameter"
          },
          "name": {
            "type": "string",
            "description": "name parameter"
          },
          "surname": {
            "type": "string",
            "description": "surname parameter"
          },
          "phone": {
            "type": "string",
            "description": "Phone number in E.164 format (leading \"+\" then 7-15 digits)"
          }
        },
        "required": [
          "email"
        ]
      }
    },
    "tag_uuids": {
      "type": "array",
      "description": "Existing tags to attach to every created contact",
      "items": {
        "type": "string",
        "description": "tag_uuids parameter"
      }
    },
    "note": {
      "type": "string",
      "description": "Note applied to every created contact"
    }
  },
  "required": [
    "profileUuid",
    "contacts"
  ]
}

{
  "title": "Create contacts in bulk",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "email": {
      "type": "string",
      "description": "email parameter"
    },
    "name": {
      "type": "string",
      "description": "name parameter"
    },
    "surname": {
      "type": "string",
      "description": "surname parameter"
    },
    "phone": {
      "type": "string",
      "description": "Phone number in E.164 format (leading \"+\" then 7-15 digits)"
    },
    "note": {
      "type": "string",
      "description": "note parameter"
    },
    "tag_uuids": {
      "type": "array",
      "description": "Existing tags to attach to the created contact",
      "items": {
        "type": "string",
        "description": "tag_uuids parameter"
      }
    }
  },
  "required": [
    "profileUuid",
    "email"
  ]
}

{
  "title": "Create new contacts",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "names": {
      "type": "array",
      "description": "names parameter",
      "items": {
        "type": "string",
        "description": "names parameter"
      }
    }
  },
  "required": [
    "profileUuid",
    "names"
  ]
}

{
  "title": "Create or find tags",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "fieldUuid": {
      "type": "string",
      "description": "Contact field uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "fieldUuid"
  ]
}

{
  "title": "Delete a contact field",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "uuid": {
      "type": "string",
      "description": "UUID of the contact to delete"
    }
  },
  "required": [
    "uuid"
  ]
}

{
  "title": "Delete a contact",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "contactUuid": {
      "type": "string",
      "description": "Contact uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "contactUuid"
  ]
}

{
  "title": "Delete a profile contact",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "segmentUuid": {
      "type": "string",
      "description": "Segment uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "segmentUuid"
  ]
}

{
  "title": "Delete a profile segment",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "tagUuid": {
      "type": "string",
      "description": "Tag uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "tagUuid"
  ]
}

{
  "title": "Delete a tag",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "formUuid": {
      "type": "string",
      "description": "Form uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "formUuid"
  ]
}

{
  "title": "Delete form",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "automationUuid": {
      "type": "string",
      "description": "Automation uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "automationUuid"
  ]
}

{
  "title": "Get automation details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "campaignUuid": {
      "type": "string",
      "description": "Campaign uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "campaignUuid"
  ]
}

{
  "title": "Get campaign details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "campaignUuid": {
      "type": "string",
      "description": "Campaign uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "campaignUuid"
  ]
}

{
  "title": "Get campaign performance",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "Get connected sending domain",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "contactUuid": {
      "type": "string",
      "description": "Contact uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "contactUuid"
  ]
}

{
  "title": "Get contact details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "formUuid": {
      "type": "string",
      "description": "Form uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "formUuid"
  ]
}

{
  "title": "Get form details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "Get profile domain DNS status",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "segmentUuid": {
      "type": "string",
      "description": "Segment uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "segmentUuid"
  ]
}

{
  "title": "Get profile segment details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "Get remaining plan limits",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "segmentUuid": {
      "type": "string",
      "description": "Segment uuid parameter"
    }
  },
  "required": [
    "segmentUuid"
  ]
}

{
  "title": "Get segment details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "automationUuid": {
      "type": "string",
      "description": "Automation uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "automationUuid"
  ]
}

{
  "title": "List automation steps",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "status": {
      "type": "string",
      "description": "Filter automations by status.\n\nThere is no `completed` status. An automation that has finished for every contact still\nreports `active`.",
      "enum": [
        "active",
        "paused",
        "draft"
      ]
    },
    "sort_direction": {
      "type": "string",
      "description": "Order automations by creation date. Newest first unless set to `asc`.",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List automations",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "status": {
      "type": "string",
      "description": "Filter campaigns by status.\n\nA fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can\nbe neither paused nor archived.",
      "enum": [
        "draft",
        "scheduled",
        "sending",
        "publish",
        "failed"
      ]
    },
    "type": {
      "type": "string",
      "description": "Filter campaigns by type.\n\nDefaults to `campaign`, which leaves out the emails sent by automations and the double\nopt-in confirmations.",
      "enum": [
        "campaign",
        "automation",
        "double_opt_in"
      ]
    },
    "sort_direction": {
      "type": "string",
      "description": "Order campaigns by creation date. Newest first unless set to `asc`.",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List campaigns",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List contact fields",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "List contact groups",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "group_uuid": {
      "type": "string",
      "description": "Filter contacts by group UUID"
    },
    "subscription_status": {
      "type": "string",
      "description": "Filter contacts by subscription status",
      "enum": [
        "subscribed",
        "unsubscribed",
        "confirmed",
        "pending"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": []
}

{
  "title": "List contacts",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List email templates",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List forms",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List plan feature access",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "subscription_status": {
      "type": "string",
      "description": "Filter contacts by subscription status",
      "enum": [
        "subscribed",
        "unsubscribed",
        "confirmed",
        "pending"
      ]
    },
    "tag_uuid": {
      "type": "string",
      "description": "Filter contacts by tag UUID"
    },
    "search": {
      "type": "string",
      "description": "Search contacts by email"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List profile contacts",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "segmentUuid": {
      "type": "string",
      "description": "Segment uuid parameter"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "profileUuid",
    "segmentUuid"
  ]
}

{
  "title": "List profile segment contacts",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "count_type": {
      "type": "string",
      "description": "Which matching contacts to count for each segment",
      "enum": [
        "all",
        "subscribed"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List profile segments",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "List Profiles",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List profile tags",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "segmentUuid": {
      "type": "string",
      "description": "Segment uuid parameter"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    }
  },
  "required": [
    "segmentUuid"
  ]
}

{
  "title": "List segment contacts",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    }
  },
  "required": [
    "profileUuid"
  ]
}

{
  "title": "List segment filter attributes",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "List segments",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "conditions": {
      "type": "array",
      "description": "Conditions a contact must satisfy to appear in the preview",
      "items": {
        "type": "object",
        "description": "conditions parameter",
        "properties": {
          "attribute": {
            "type": "string",
            "description": "A built-in contact attribute, or `cf:{fieldUuid}` to target a custom\ncontact field. Which operators are accepted depends on the attribute,\nso read the segment filter attributes endpoint for the authoritative\nlist."
          },
          "operator": {
            "type": "string",
            "description": "operator parameter",
            "enum": [
              "equals",
              "not_equals",
              "contains",
              "not_contains",
              "gte",
              "lte",
              "exists",
              "within_last_days",
              "not_within_last_days",
              "older_than_days",
              "processed",
              "not_processed",
              "delivered",
              "not_delivered",
              "dropped",
              "not_dropped",
              "bounced",
              "not_bounced",
              "soft_bounced",
              "not_soft_bounced",
              "opened",
              "not_opened",
              "clicked",
              "not_clicked",
              "unsubscribed",
              "not_unsubscribed"
            ]
          },
          "value": {
            "type": "string",
            "description": "Always a string, including for numeric and date comparisons"
          }
        },
        "required": [
          "attribute",
          "operator",
          "value"
        ]
      }
    },
    "logic": {
      "type": "string",
      "description": "How to combine multiple conditions",
      "enum": [
        "AND",
        "OR"
      ]
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of items per page"
    },
    "search": {
      "type": "string",
      "description": "Narrow the preview to contacts whose email matches"
    },
    "sort_by": {
      "type": "string",
      "description": "sort_by parameter",
      "enum": [
        "email",
        "name",
        "surname",
        "phone",
        "subscription_status"
      ]
    },
    "sort_direction": {
      "type": "string",
      "description": "sort_direction parameter",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "profileUuid",
    "conditions",
    "logic"
  ]
}

{
  "title": "Preview contacts matching conditions",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "tagUuid": {
      "type": "string",
      "description": "Tag uuid parameter"
    },
    "contactUuid": {
      "type": "string",
      "description": "Contact uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "tagUuid",
    "contactUuid"
  ]
}

{
  "title": "Remove a contact from a tag",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "tagUuid": {
      "type": "string",
      "description": "Tag uuid parameter"
    }
  },
  "required": [
    "profileUuid",
    "tagUuid"
  ]
}

{
  "title": "Remove contacts from a tag",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "tagUuid": {
      "type": "string",
      "description": "Tag uuid parameter"
    },
    "value": {
      "type": "string",
      "description": "New tag name"
    }
  },
  "required": [
    "profileUuid",
    "tagUuid",
    "value"
  ]
}

{
  "title": "Rename a tag",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "fieldUuid": {
      "type": "string",
      "description": "Contact field uuid parameter"
    },
    "label": {
      "type": "string",
      "description": "label parameter"
    },
    "options": {
      "type": "array",
      "description": "Replaces the option set when provided. Entries carrying a uuid are kept and relabelled, entries without one are created, and any existing option missing from the list is deleted along with the values contacts hold for it.",
      "items": {
        "type": "object",
        "description": "options parameter",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "uuid parameter"
          },
          "label": {
            "type": "string",
            "description": "label parameter"
          }
        },
        "required": [
          "label"
        ]
      }
    }
  },
  "required": [
    "profileUuid",
    "fieldUuid",
    "label"
  ]
}

{
  "title": "Update a contact field",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "contactUuid": {
      "type": "string",
      "description": "Contact uuid parameter"
    },
    "email": {
      "type": "string",
      "description": "email parameter"
    },
    "name": {
      "type": "string",
      "description": "name parameter"
    },
    "surname": {
      "type": "string",
      "description": "surname parameter"
    },
    "phone": {
      "type": "string",
      "description": "Phone number in E.164 format (leading \"+\" then 7-15 digits)"
    },
    "subscription_status": {
      "type": "string",
      "description": "subscription_status parameter",
      "enum": [
        "subscribed",
        "unsubscribed",
        "confirmed",
        "pending"
      ]
    },
    "note": {
      "type": "string",
      "description": "note parameter"
    },
    "fields": {
      "type": "array",
      "description": "Set custom field values. Omit to leave untouched, send an empty array to clear them all.",
      "items": {
        "type": "object",
        "description": "fields parameter",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "uuid parameter"
          },
          "value": {
            "type": "string",
            "description": "For the scalar field types"
          },
          "selected_option_uuids": {
            "type": "array",
            "description": "For the choice field types",
            "items": {
              "type": "string",
              "description": "selected_option_uuids parameter"
            }
          }
        },
        "required": [
          "uuid"
        ]
      }
    }
  },
  "required": [
    "profileUuid",
    "contactUuid"
  ]
}

{
  "title": "Update a contact",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "profileUuid": {
      "type": "string",
      "description": "Profile uuid parameter"
    },
    "segmentUuid": {
      "type": "string",
      "description": "Segment uuid parameter"
    },
    "name": {
      "type": "string",
      "description": "name parameter"
    },
    "conditions": {
      "type": "array",
      "description": "Replaces the existing conditions entirely. Omit to keep the current ones.",
      "items": {
        "type": "object",
        "description": "conditions parameter",
        "properties": {
          "attribute": {
            "type": "string",
            "description": "A built-in contact attribute, or `cf:{fieldUuid}` to target a custom\ncontact field. Custom fields are addressed by field UUID; their slug\nis not accepted.\n\nBuilt-in attributes: `email`, `note`, `domain`, `source`,\n`opt_in_method`, `subscription_status`, `subscribed_at`,\n`unsubscribed_at`, `created_at`, `tag`, `campaigns`, `processed`,\n`opened`, `clicked`, `delivered`, `bounced`, `soft_bounced`,\n`dropped`.\n\nWhich operators are accepted depends on the attribute."
          },
          "operator": {
            "type": "string",
            "description": "operator parameter",
            "enum": [
              "equals",
              "not_equals",
              "contains",
              "not_contains",
              "gte",
              "lte",
              "exists",
              "within_last_days",
              "not_within_last_days",
              "older_than_days",
              "processed",
              "not_processed",
              "delivered",
              "not_delivered",
              "dropped",
              "not_dropped",
              "bounced",
              "not_bounced",
              "soft_bounced",
              "not_soft_bounced",
              "opened",
              "not_opened",
              "clicked",
              "not_clicked",
              "unsubscribed",
              "not_unsubscribed"
            ]
          },
          "value": {
            "type": "string",
            "description": "Always a string, including for numeric and date comparisons"
          }
        },
        "required": [
          "attribute",
          "operator",
          "value"
        ]
      }
    },
    "logic": {
      "type": "string",
      "description": "How to combine multiple conditions. Required when conditions are given.",
      "enum": [
        "AND",
        "OR"
      ]
    }
  },
  "required": [
    "profileUuid",
    "segmentUuid",
    "name"
  ]
}

{
  "title": "Update a profile segment",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get domain verifications",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    },
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "firewallId",
    "virtualMachineId"
  ]
}

{
  "title": "Activate firewall",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "ids": {
      "type": "array",
      "description": "Public Key IDs to attach",
      "items": {
        "type": "integer",
        "description": "ids parameter"
      }
    }
  },
  "required": [
    "virtualMachineId",
    "ids"
  ]
}

{
  "title": "Attach public key",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    },
    "protocol": {
      "type": "string",
      "description": "protocol parameter",
      "enum": [
        "TCP",
        "UDP",
        "ICMP",
        "GRE",
        "any",
        "ESP",
        "AH",
        "ICMPv6",
        "SSH",
        "HTTP",
        "HTTPS",
        "MySQL",
        "PostgreSQL"
      ]
    },
    "port": {
      "type": "string",
      "description": "Port or port range, ex: 1024:2048"
    },
    "source": {
      "type": "string",
      "description": "source parameter",
      "enum": [
        "any",
        "custom"
      ]
    },
    "source_detail": {
      "type": "string",
      "description": "IP range, CIDR, single IP or `any`"
    }
  },
  "required": [
    "firewallId",
    "protocol",
    "port",
    "source",
    "source_detail"
  ]
}

{
  "title": "Create firewall rule",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "name parameter"
    }
  },
  "required": [
    "name"
  ]
}

{
  "title": "Create new firewall",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "project_name": {
      "type": "string",
      "description": "Docker Compose project name using alphanumeric characters, dashes, and underscores only"
    },
    "content": {
      "type": "string",
      "description": "URL pointing to docker-compose.yaml file, Github repository or raw YAML content of the compose file"
    },
    "environment": {
      "type": "string",
      "description": "Project environment variables"
    }
  },
  "required": [
    "virtualMachineId",
    "project_name",
    "content"
  ]
}

{
  "title": "Create new project",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the script"
    },
    "content": {
      "type": "string",
      "description": "Content of the script"
    }
  },
  "required": [
    "name",
    "content"
  ]
}

{
  "title": "Create post-install script",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "ipAddressId": {
      "type": "integer",
      "description": "IP Address ID"
    },
    "domain": {
      "type": "string",
      "description": "Pointer record domain"
    }
  },
  "required": [
    "virtualMachineId",
    "ipAddressId",
    "domain"
  ]
}

{
  "title": "Create PTR record",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "name parameter"
    },
    "key": {
      "type": "string",
      "description": "key parameter"
    }
  },
  "required": [
    "name",
    "key"
  ]
}

{
  "title": "Create public key",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Create snapshot",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    },
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "firewallId",
    "virtualMachineId"
  ]
}

{
  "title": "Deactivate firewall",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    },
    "ruleId": {
      "type": "integer",
      "description": "Firewall Rule ID"
    }
  },
  "required": [
    "firewallId",
    "ruleId"
  ]
}

{
  "title": "Delete firewall rule",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    }
  },
  "required": [
    "firewallId"
  ]
}

{
  "title": "Delete firewall",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "postInstallScriptId": {
      "type": "integer",
      "description": "Post-install script ID"
    }
  },
  "required": [
    "postInstallScriptId"
  ]
}

{
  "title": "Delete post-install script",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "projectName": {
      "type": "string",
      "description": "Docker Compose project name using alphanumeric characters, dashes, and underscores only"
    }
  },
  "required": [
    "virtualMachineId",
    "projectName"
  ]
}

{
  "title": "Delete project",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "ipAddressId": {
      "type": "integer",
      "description": "IP Address ID"
    }
  },
  "required": [
    "virtualMachineId",
    "ipAddressId"
  ]
}

{
  "title": "Delete PTR record",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "publicKeyId": {
      "type": "integer",
      "description": "Public Key ID"
    }
  },
  "required": [
    "publicKeyId"
  ]
}

{
  "title": "Delete public key",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Delete snapshot",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "actionId": {
      "type": "integer",
      "description": "Action ID"
    }
  },
  "required": [
    "virtualMachineId",
    "actionId"
  ]
}

{
  "title": "Get action details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Get actions",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Get attached public keys",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Get backups",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get data center list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    }
  },
  "required": [
    "firewallId"
  ]
}

{
  "title": "Get firewall details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": []
}

{
  "title": "Get firewall list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "date_from": {
      "type": "string",
      "description": "date_from parameter"
    },
    "date_to": {
      "type": "string",
      "description": "date_to parameter"
    }
  },
  "required": [
    "virtualMachineId",
    "date_from",
    "date_to"
  ]
}

{
  "title": "Get metrics",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": []
}

{
  "title": "Get post-install scripts",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "postInstallScriptId": {
      "type": "integer",
      "description": "Post-install script ID"
    }
  },
  "required": [
    "postInstallScriptId"
  ]
}

{
  "title": "Get post-install script",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "projectName": {
      "type": "string",
      "description": "Docker Compose project name using alphanumeric characters, dashes, and underscores only"
    }
  },
  "required": [
    "virtualMachineId",
    "projectName"
  ]
}

{
  "title": "Get project containers",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "projectName": {
      "type": "string",
      "description": "Docker Compose project name using alphanumeric characters, dashes, and underscores only"
    }
  },
  "required": [
    "virtualMachineId",
    "projectName"
  ]
}

{
  "title": "Get project contents",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Get project list",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "projectName": {
      "type": "string",
      "description": "Docker Compose project name using alphanumeric characters, dashes, and underscores only"
    }
  },
  "required": [
    "virtualMachineId",
    "projectName"
  ]
}

{
  "title": "Get project logs",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": []
}

{
  "title": "Get public keys",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Get scan metrics",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Get snapshot",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "templateId": {
      "type": "integer",
      "description": "Template ID"
    }
  },
  "required": [
    "templateId"
  ]
}

{
  "title": "Get template details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get templates",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Get virtual machine details",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {},
  "required": []
}

{
  "title": "Get virtual machines",
  "readOnlyHint": true,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Install Monarx",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "item_id": {
      "type": "string",
      "description": "Catalog price item ID"
    },
    "payment_method_id": {
      "type": "integer",
      "description": "Payment method ID, default will be used if not provided"
    },
    "setup": {
      "type": "string",
      "description": "setup parameter"
    },
    "coupons": {
      "type": "array",
      "description": "Discount coupon codes",
      "items": {
        "type": "string",
        "description": "coupons parameter"
      }
    }
  },
  "required": [
    "item_id",
    "setup"
  ]
}

{
  "title": "Purchase new virtual machine",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "template_id": {
      "type": "integer",
      "description": "Template ID"
    },
    "password": {
      "type": "string",
      "description": "Root password for the virtual machine. If not provided, random password will be generated.\nPassword will not be shown in the response."
    },
    "panel_password": {
      "type": "string",
      "description": "Panel password for the panel-based OS template. If not provided, random password will be generated.\nIf OS does not support panel_password this field will be ignored.\nPassword will not be shown in the response."
    },
    "post_install_script_id": {
      "type": "integer",
      "description": "Post-install script to execute after virtual machine was recreated"
    }
  },
  "required": [
    "virtualMachineId",
    "template_id"
  ]
}

{
  "title": "Recreate virtual machine",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    },
    "rules": {
      "type": "array",
      "description": "The complete set of firewall rules that atomically replaces all existing rules in the group",
      "items": {
        "type": "string",
        "description": "rules parameter"
      }
    },
    "sync": {
      "type": "boolean",
      "description": "Synchronize the firewall group to all its virtual machines after replacing the rules"
    }
  },
  "required": [
    "firewallId",
    "rules"
  ]
}

{
  "title": "Replace all firewall rules in group",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Reset hostname",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "projectName": {
      "type": "string",
      "description": "Docker Compose project name using alphanumeric characters, dashes, and underscores only"
    }
  },
  "required": [
    "virtualMachineId",
    "projectName"
  ]
}

{
  "title": "Restart project",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Restart virtual machine",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "backupId": {
      "type": "integer",
      "description": "Backup ID"
    }
  },
  "required": [
    "virtualMachineId",
    "backupId"
  ]
}

{
  "title": "Restore backup",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Restore snapshot",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "hostname": {
      "type": "string",
      "description": "hostname parameter"
    }
  },
  "required": [
    "virtualMachineId",
    "hostname"
  ]
}

{
  "title": "Set hostname",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "ns1": {
      "type": "string",
      "description": "ns1 parameter"
    },
    "ns2": {
      "type": "string",
      "description": "ns2 parameter"
    },
    "ns3": {
      "type": "string",
      "description": "ns3 parameter"
    }
  },
  "required": [
    "virtualMachineId",
    "ns1"
  ]
}

{
  "title": "Set nameservers",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "password": {
      "type": "string",
      "description": "Panel password for the virtual machine"
    }
  },
  "required": [
    "virtualMachineId",
    "password"
  ]
}

{
  "title": "Set panel password",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "password": {
      "type": "string",
      "description": "Root password for the virtual machine"
    }
  },
  "required": [
    "virtualMachineId",
    "password"
  ]
}

{
  "title": "Set root password",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "template_id": {
      "type": "integer",
      "description": "Template ID"
    },
    "data_center_id": {
      "type": "integer",
      "description": "Data center ID"
    },
    "post_install_script_id": {
      "type": "integer",
      "description": "Post-install script ID"
    },
    "password": {
      "type": "string",
      "description": "Password for the virtual machine. If not provided, random password will be generated.\nPassword will not be shown in the response."
    },
    "hostname": {
      "type": "string",
      "description": "Override default hostname of the virtual machine"
    },
    "install_monarx": {
      "type": "boolean",
      "description": "Install Monarx malware scanner (if supported)"
    },
    "enable_backups": {
      "type": "boolean",
      "description": "Enable weekly backup schedule"
    },
    "ns1": {
      "type": "string",
      "description": "Name server 1"
    },
    "ns2": {
      "type": "string",
      "description": "Name server 2"
    },
    "public_key": {
      "type": "object",
      "description": "Use SSH key",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the SSH key"
        },
        "key": {
          "type": "string",
          "description": "Contents of the SSH key"
        }
      }
    }
  },
  "required": [
    "virtualMachineId",
    "data_center_id",
    "template_id"
  ]
}

{
  "title": "Setup purchased virtual machine",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "projectName": {
      "type": "string",
      "description": "Docker Compose project name using alphanumeric characters, dashes, and underscores only"
    }
  },
  "required": [
    "virtualMachineId",
    "projectName"
  ]
}

{
  "title": "Start project",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "root_password": {
      "type": "string",
      "description": "Temporary root password for recovery mode"
    }
  },
  "required": [
    "virtualMachineId",
    "root_password"
  ]
}

{
  "title": "Start recovery mode",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Start virtual machine",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "projectName": {
      "type": "string",
      "description": "Docker Compose project name using alphanumeric characters, dashes, and underscores only"
    }
  },
  "required": [
    "virtualMachineId",
    "projectName"
  ]
}

{
  "title": "Stop project",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Stop recovery mode",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Stop virtual machine",
  "readOnlyHint": false,
  "destructiveHint": true
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    }
  },
  "required": [
    "firewallId"
  ]
}

{
  "title": "Sync firewall to all assigned VMs",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    },
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "firewallId",
    "virtualMachineId"
  ]
}

{
  "title": "Sync firewall",
  "readOnlyHint": false,
  "destructiveHint": false
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    }
  },
  "required": [
    "virtualMachineId"
  ]
}

{
  "title": "Uninstall Monarx",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "firewallId": {
      "type": "integer",
      "description": "Firewall ID"
    },
    "ruleId": {
      "type": "integer",
      "description": "Firewall Rule ID"
    },
    "protocol": {
      "type": "string",
      "description": "protocol parameter",
      "enum": [
        "TCP",
        "UDP",
        "ICMP",
        "GRE",
        "any",
        "ESP",
        "AH",
        "ICMPv6",
        "SSH",
        "HTTP",
        "HTTPS",
        "MySQL",
        "PostgreSQL"
      ]
    },
    "port": {
      "type": "string",
      "description": "Port or port range, ex: 1024:2048"
    },
    "source": {
      "type": "string",
      "description": "source parameter",
      "enum": [
        "any",
        "custom"
      ]
    },
    "source_detail": {
      "type": "string",
      "description": "IP range, CIDR, single IP or `any`"
    }
  },
  "required": [
    "firewallId",
    "ruleId",
    "protocol",
    "port",
    "source",
    "source_detail"
  ]
}

{
  "title": "Update firewall rule",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "postInstallScriptId": {
      "type": "integer",
      "description": "Post-install script ID"
    },
    "name": {
      "type": "string",
      "description": "Name of the script"
    },
    "content": {
      "type": "string",
      "description": "Content of the script"
    }
  },
  "required": [
    "postInstallScriptId",
    "name",
    "content"
  ]
}

{
  "title": "Update post-install script",
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true
}

{
  "type": "object",
  "properties": {
    "virtualMachineId": {
      "type": "integer",
      "description": "Virtual Machine ID"
    },
    "projectName": {
      "type": "string",
      "description": "Docker Compose project name using alphanumeric characters, dashes, and underscores only"
    }
  },
  "required": [
    "virtualMachineId",
    "projectName"
  ]
}

{
  "title": "Update project",
  "readOnlyHint": false,
  "destructiveHint": false
}