Question Plesk REST API for PHP

[Riculum]

Hello everyone

I am trying to automate the ordering process. I want to use the REST API and PHP. The official documentation is not very helpful, hardly anything is described. The swagger version is not very informative either. Does anyone know good documentation that describes how to create a new subscription?

Greetings

 

[IgorG]

In my opinion, the easiest way would be to use 'subscription' CLI utility call with the necessary parameters through the REST API. More details in this KB article How to manage Plesk via REST API?
This blog article also may be useful New Remote Plesk REST API for Automation

 

[Riculum]

Thank you for the quick feedback. What do you mean by use 'subscription' CLI utility use. I see the command /cli/commands in the swagger documentation. This gives me a list. But how do I use it?

 

[IgorG]

But how do I use it?

There are examples in the mentioned KB article.

 

[mrsombre]

Hello, most recent documentation incl. swagger scheme and playground can be found under Tools & Settings > Server Management > Remote API (REST) page.

 

[mrsombre]

Example of creating a domain using REST API

POST https://{{api_host}}:{{api_port}}/api/v2/domains
Accept: application/json
X-API-Key: {{api_token}}

{
  "name": "test.dev",
  "hosting_type": "virtual",
  "hosting_settings": {
    "ftp_login": "test_login",
    "ftp_password": "test_password"
  },
  "plan": {
    "name": "Unlimited"
  }
}

 

[Riculum]

I'm sorry, but I don't get it. I successfully created a user and a domain with CURL and PHP. However, I don't see in the documentation how to set this up for a subscription. Sorry, but there is nothing in the KB about how I use the CLI in PHP. I found this:

plesk bin subscription --create example.com -owner admin -service-plan "Default Domain" -ip 192.168.1.100 -login jdoe -passwd "userpass"

LINK: subscription: Subscriptions

How can I use this in PHP?

 

[mrsombre]

I don't see in the documentation how to set this up for a subscription.

When you use /domains endpoint in REST it creates a subscription when no 'base_domain' nor 'parent_domain' provided.

You can use all CLI commands using /cli endpoint like this

POST https://{{api_host}}:{{api_port}}/api/v2/cli/subscription/call
Accept: application/json
X-API-Key: {{api_token}}
{"params": ["--create", "example.com", "-owner", "admin", "-service-plan", "Default Domain", "-login", "jdoe", "-passwd", "userpass", "-ip", "10.58.108.108"]}

 

[Riculum]

So if I understand correctly it automatically creates a subscription when I create a domain. Under "base_domain" you need an "id" and a "guid". The domain doesn't exist yet (will be created first). Where should I get these values from?

 

[mrsombre]

it automatically creates a subscription when I create a domain

Correct

The domain doesn't exist yet (will be created first). Where should I get these values from?

You do not need pass 'base_domain' option if you would like create a new subscription.

PS Did you tried CLI endpoint from my previous posting?