Introduction

This documentation aims to provide all the information you need to work with our API. The documentation is work in progress and it's currently missing proper descriptions and examples.

Authenticating requests

To authenticate requests, include an Authorization header with your API Token, example: Authorization: Bearer {YOUR_API_TOKEN}

To call user endpoints, include additional X-PanelAlpha-User header with the user's ID, example: X-PanelAlpha-User: 12

You can retrieve your token in Configuration -> Admins section of admin area.

Admin Endpoints

System

Show system configuration

Example request:

curl --request GET \
    --get "/api/admin/settings" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/settings';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/settings'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update system configuration

Example request:

curl --request PUT \
    "/api/admin/settings" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/settings';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/settings'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

SSL

List SSL providers

Example request:

curl --request GET \
    --get "/api/admin/ssl/providers" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/ssl/providers"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/ssl/providers';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/ssl/providers'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List SSL orders

Example request:

curl --request GET \
    --get "/api/admin/ssl-orders" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/ssl-orders"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/ssl-orders';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/ssl-orders'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List SSL logs

Example request:

curl --request GET \
    --get "/api/admin/ssl-orders/logs" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/ssl-orders/logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/ssl-orders/logs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/ssl-orders/logs'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Process SSL order

Example request:

curl --request PUT \
    "/api/admin/ssl-orders/17/process" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/ssl-orders/17/process"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/ssl-orders/17/process';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/ssl-orders/17/process'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Abandon SSL Order

Example request:

curl --request PUT \
    "/api/admin/ssl-orders/17/abandon" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/ssl-orders/17/abandon"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/ssl-orders/17/abandon';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/ssl-orders/17/abandon'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Users

List users

Example request:

curl --request GET \
    --get "/api/admin/users" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"filter\": \"odit\"
}"

const url = new URL(
    "/api/admin/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filter": "odit"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'filter' => 'odit',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users'
payload = {
    "filter": "odit"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create user

Example request:

curl --request POST \
    "/api/admin/users" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"first_name\": \"pn\",
    \"last_name\": \"tupzaol\",
    \"company_name\": \"bmhiklhbhzlgsqs\",
    \"email\": \"vaughn.abbott@example.com\",
    \"password\": \"c]Bm)aRLI>Z[\",
    \"password_change_required\": true,
    \"send_email\": false
}"

const url = new URL(
    "/api/admin/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "pn",
    "last_name": "tupzaol",
    "company_name": "bmhiklhbhzlgsqs",
    "email": "vaughn.abbott@example.com",
    "password": "c]Bm)aRLI>Z[",
    "password_change_required": true,
    "send_email": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'first_name' => 'pn',
            'last_name' => 'tupzaol',
            'company_name' => 'bmhiklhbhzlgsqs',
            'email' => 'vaughn.abbott@example.com',
            'password' => 'c]Bm)aRLI>Z[',
            'password_change_required' => true,
            'send_email' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users'
payload = {
    "first_name": "pn",
    "last_name": "tupzaol",
    "company_name": "bmhiklhbhzlgsqs",
    "email": "vaughn.abbott@example.com",
    "password": "c]Bm)aRLI>Z[",
    "password_change_required": true,
    "send_email": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/users

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

first_name string optional

Must not be greater than 255 characters. Example: pn

last_name string optional

Must not be greater than 255 characters. Example: tupzaol

company_name string optional

Must not be greater than 255 characters. Example: bmhiklhbhzlgsqs

email string

Must be a valid email address. Must not be greater than 255 characters. Example: vaughn.abbott@example.com

password string

Must be at least 8 characters. Example: c]Bm)aRLI>Z[

password_change_required boolean optional true false

Example: true

send_email boolean optional true false

Example: false

List archived users

Example request:

curl --request GET \
    --get "/api/admin/users/archived" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/archived"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/archived';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/archived'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Find user by email

Example request:

curl --request GET \
    --get "/api/admin/users/email?email=user%40example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/email"
);

const params = {
    "email": "user@example.com",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/email';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'email' => 'user@example.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/email'
params = {
  'email': 'user@example.com',
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show archived user details

Example request:

curl --request GET \
    --get "/api/admin/users/10/archived" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/10/archived"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/10/archived';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/10/archived'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show user details

Example request:

curl --request GET \
    --get "/api/admin/users/18" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/18"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/18';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/18'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get user's last activity

Example request:

curl --request GET \
    --get "/api/admin/users/3/last-activity" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/3/last-activity"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/3/last-activity';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/3/last-activity'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Unarchive user

Example request:

curl --request PUT \
    "/api/admin/users/12/unarchive" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/12/unarchive"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/12/unarchive';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/12/unarchive'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update user

Example request:

curl --request PUT \
    "/api/admin/users/6" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"first_name\": \"coaknnablmuvapxvwfqp\",
    \"last_name\": \"ktilmtqpjhff\",
    \"company_name\": \"fcvnvxydxry\",
    \"email\": \"ophelia44@example.com\",
    \"password\": \"wvu?wn:U;E\",
    \"password_change_required\": false
}"

const url = new URL(
    "/api/admin/users/6"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "coaknnablmuvapxvwfqp",
    "last_name": "ktilmtqpjhff",
    "company_name": "fcvnvxydxry",
    "email": "ophelia44@example.com",
    "password": "wvu?wn:U;E",
    "password_change_required": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/6';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'first_name' => 'coaknnablmuvapxvwfqp',
            'last_name' => 'ktilmtqpjhff',
            'company_name' => 'fcvnvxydxry',
            'email' => 'ophelia44@example.com',
            'password' => 'wvu?wn:U;E',
            'password_change_required' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/6'
payload = {
    "first_name": "coaknnablmuvapxvwfqp",
    "last_name": "ktilmtqpjhff",
    "company_name": "fcvnvxydxry",
    "email": "ophelia44@example.com",
    "password": "wvu?wn:U;E",
    "password_change_required": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/users/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

User ID. Example: 6

Body Parameters

first_name string optional

Must not be greater than 255 characters. Example: coaknnablmuvapxvwfqp

last_name string optional

Must not be greater than 255 characters. Example: ktilmtqpjhff

company_name string optional

Must not be greater than 255 characters. Example: fcvnvxydxry

email string

Must be a valid email address. Must not be greater than 255 characters. Example: ophelia44@example.com

password string optional

Must be at least 8 characters. Example: wvu?wn:U;E

password_change_required boolean optional true false

Example: false

Delete archived user

Example request:

curl --request DELETE \
    "/api/admin/users/2/delete" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/2/delete"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/2/delete';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/2/delete'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete user

Example request:

curl --request DELETE \
    "/api/admin/users/15" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/15"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/15';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/15'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create user SSO token

Example request:

curl --request POST \
    "/api/admin/users/7/sso-token" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/7/sso-token"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/7/sso-token';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/7/sso-token'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "/api/admin/users/11/login-as-user-sso-token" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/11/login-as-user-sso-token"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/11/login-as-user-sso-token';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/11/login-as-user-sso-token'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Disable two-factor authentication for user

Example request:

curl --request PUT \
    "/api/admin/users/11/disable-two-factor-authentication" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/11/disable-two-factor-authentication"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/11/disable-two-factor-authentication';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/11/disable-two-factor-authentication'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Force user to reset their password

Example request:

curl --request PUT \
    "/api/admin/users/16/require-reset-password" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/16/require-reset-password"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/16/require-reset-password';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/16/require-reset-password'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "/api/admin/users/17/sharing-with" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/17/sharing-with"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/17/sharing-with';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/17/sharing-with'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "/api/admin/users/15/sharing-with/9/shared-instances" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/15/sharing-with/9/shared-instances"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/15/sharing-with/9/shared-instances';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/15/sharing-with/9/shared-instances'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List all instances

Returns all instances the user has access to.

Example request:

curl --request GET \
    --get "/api/admin/users/19/all-instances" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/19/all-instances"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/19/all-instances';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/19/all-instances'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List user services

Example request:

curl --request GET \
    --get "/api/admin/users/14/services" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/14/services"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/14/services';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/14/services'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create user service

Example request:

curl --request POST \
    "/api/admin/users/10/services" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"plan_id\": 11
}"

const url = new URL(
    "/api/admin/users/10/services"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "plan_id": 11
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/10/services';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'plan_id' => 11,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/10/services'
payload = {
    "plan_id": 11
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Suspend user service

Example request:

curl --request PUT \
    "/api/admin/users/8/services/9/suspend" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/8/services/9/suspend"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/8/services/9/suspend';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/8/services/9/suspend'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Unsuspend user service

Example request:

curl --request PUT \
    "/api/admin/users/12/services/3/unsuspend" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/users/12/services/3/unsuspend"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/12/services/3/unsuspend';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/12/services/3/unsuspend'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Change user service's plan

Example request:

curl --request PUT \
    "/api/admin/users/10/services/14/change-plan" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"plan_id\": 20
}"

const url = new URL(
    "/api/admin/users/10/services/14/change-plan"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "plan_id": 20
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/users/10/services/14/change-plan';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'plan_id' => 20,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/users/10/services/14/change-plan'
payload = {
    "plan_id": 20
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/users/{userId}/services/{id}/change-plan

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

userId integer

User ID. Example: 10

id integer

Service ID. Example: 14

Body Parameters

plan_id integer

Example: 20

Admins

List admin accounts

Example request:

curl --request GET \
    --get "/api/admin/admins" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/admins"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admins';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admins'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Add admin account

Example request:

curl --request POST \
    "/api/admin/admins" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"fkrbz\",
    \"admin_group_id\": 8,
    \"email\": \"ylang@example.com\",
    \"password\": \"\\\"sfrFc\\\\qiGbUa,Lry<@\"
}"

const url = new URL(
    "/api/admin/admins"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "fkrbz",
    "admin_group_id": 8,
    "email": "ylang@example.com",
    "password": "\"sfrFc\\qiGbUa,Lry<@"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admins';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'fkrbz',
            'admin_group_id' => 8,
            'email' => 'ylang@example.com',
            'password' => '"sfrFc\\qiGbUa,Lry<@',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admins'
payload = {
    "name": "fkrbz",
    "admin_group_id": 8,
    "email": "ylang@example.com",
    "password": "\"sfrFc\\qiGbUa,Lry<@"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/admins

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

name string

Must not be greater than 255 characters. Example: fkrbz

admin_group_id integer

Example: 8

email string

Must be a valid email address. Must not be greater than 255 characters. Example: ylang@example.com

password string

Must be at least 8 characters. Example: "sfrFc\qiGbUa,Lry<@

Show admin account details

Example request:

curl --request GET \
    --get "/api/admin/admins/9" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/admins/9"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admins/9';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admins/9'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update admin account

Example request:

curl --request PUT \
    "/api/admin/admins/9" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"wwtoq\",
    \"admin_group_id\": 11,
    \"email\": \"rollin46@example.net\",
    \"password\": \"M<pr?0ohF3K@\"
}"

const url = new URL(
    "/api/admin/admins/9"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "wwtoq",
    "admin_group_id": 11,
    "email": "rollin46@example.net",
    "password": "M<pr?0ohF3K@"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admins/9';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'wwtoq',
            'admin_group_id' => 11,
            'email' => 'rollin46@example.net',
            'password' => 'M<pr?0ohF3K@',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admins/9'
payload = {
    "name": "wwtoq",
    "admin_group_id": 11,
    "email": "rollin46@example.net",
    "password": "M<pr?0ohF3K@"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/admins/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Admin ID. Example: 9

Body Parameters

name string

Must not be greater than 255 characters. Example: wwtoq

admin_group_id integer

Example: 11

email string optional

Must be a valid email address. Must not be greater than 255 characters. Example: rollin46@example.net

password string optional

Must be at least 8 characters. Example: M<pr?0ohF3K@

Delete admin account

Example request:

curl --request DELETE \
    "/api/admin/admins/20" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/admins/20"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admins/20';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admins/20'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Change admin account status

Example request:

curl --request PUT \
    "/api/admin/admins/12/status" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"disabled\": false
}"

const url = new URL(
    "/api/admin/admins/12/status"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "disabled": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admins/12/status';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'disabled' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admins/12/status'
payload = {
    "disabled": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/admins/{id}/status

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Admin ID. Example: 12

Body Parameters

disabled boolean true false

Example: false

Enable API token

Example request:

curl --request POST \
    "/api/admin/api-tokens/17" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/api-tokens/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/api-tokens/17';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/api-tokens/17'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Disable API token

Example request:

curl --request DELETE \
    "/api/admin/api-tokens/3" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/api-tokens/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/api-tokens/3';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/api-tokens/3'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Hosting Servers

Test connection

Example request:

curl --request POST \
    "/api/admin/servers/test-connection" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"type\": \"incidunt\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/servers/test-connection"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "incidunt",
    "connection_config": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/test-connection';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'type' => 'incidunt',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/test-connection'
payload = {
    "type": "incidunt",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Test WP-CLI

Example request:

curl --request POST \
    "/api/admin/servers/test-wp-cli" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"type\": \"labore\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/servers/test-wp-cli"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "labore",
    "connection_config": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/test-wp-cli';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'type' => 'labore',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/test-wp-cli'
payload = {
    "type": "labore",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Test Server Configuration

Example request:

curl --request POST \
    "/api/admin/servers/3/check-configuration" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/3/check-configuration"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/3/check-configuration';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/3/check-configuration'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List server types

Example request:

curl --request GET \
    --get "/api/admin/servers/types" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/types"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/types'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show server type details

Example request:

curl --request GET \
    --get "/api/admin/servers/types/cpanel" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/types/cpanel"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/types/cpanel';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/types/cpanel'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List server logs

Example request:

curl --request GET \
    --get "/api/admin/servers/logs" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/logs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/logs'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List servers

Example request:

curl --request GET \
    --get "/api/admin/servers" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"group_id\": 4
}"

const url = new URL(
    "/api/admin/servers"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "group_id": 4
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'group_id' => 4,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers'
payload = {
    "group_id": 4
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show server details

Example request:

curl --request GET \
    --get "/api/admin/servers/12" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/12';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/12'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show server config

Example request:

curl --request GET \
    --get "/api/admin/servers/12/config" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/12/config"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/12/config';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/12/config'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Add server

Example request:

curl --request POST \
    "/api/admin/servers" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"sapiente\",
    \"type\": \"quisquam\",
    \"connection_config\": [],
    \"server_groups\": [
        {
            \"id\": 16,
            \"name\": \"qui\",
            \"server_type\": \"est\"
        }
    ]
}"

const url = new URL(
    "/api/admin/servers"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "sapiente",
    "type": "quisquam",
    "connection_config": [],
    "server_groups": [
        {
            "id": 16,
            "name": "qui",
            "server_type": "est"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'sapiente',
            'type' => 'quisquam',
            'connection_config' => [],
            'server_groups' => [
                [
                    'id' => 16,
                    'name' => 'qui',
                    'server_type' => 'est',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers'
payload = {
    "name": "sapiente",
    "type": "quisquam",
    "connection_config": [],
    "server_groups": [
        {
            "id": 16,
            "name": "qui",
            "server_type": "est"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/servers

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

name string

Example: sapiente

type string

Example: quisquam

connection_config object

additional_config object optional

server_groups object[]

id integer

Example: 16

name string

Example: qui

server_type string

Example: est

Update server

Example request:

curl --request PUT \
    "/api/admin/servers/17" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"type\": \"vel\",
    \"connection_config\": [],
    \"server_groups\": [
        {
            \"id\": 19,
            \"name\": \"consequuntur\",
            \"server_type\": \"vero\"
        }
    ]
}"

const url = new URL(
    "/api/admin/servers/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur",
    "type": "vel",
    "connection_config": [],
    "server_groups": [
        {
            "id": 19,
            "name": "consequuntur",
            "server_type": "vero"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/17';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'consequatur',
            'type' => 'vel',
            'connection_config' => [],
            'server_groups' => [
                [
                    'id' => 19,
                    'name' => 'consequuntur',
                    'server_type' => 'vero',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/17'
payload = {
    "name": "consequatur",
    "type": "vel",
    "connection_config": [],
    "server_groups": [
        {
            "id": 19,
            "name": "consequuntur",
            "server_type": "vero"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/servers/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Server ID. Example: 17

Body Parameters

name string

Example: consequatur

type string

Example: vel

connection_config object

additional_config object optional

server_groups object[]

id integer

Example: 19

name string

Example: consequuntur

server_type string

Example: vero

Delete server

Example request:

curl --request DELETE \
    "/api/admin/servers/20" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/20"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/20';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/20'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List PHP versions

Example request:

curl --request GET \
    --get "/api/admin/servers/4/php/versions" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/4/php/versions"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/4/php/versions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/4/php/versions'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List remote accounts

Example request:

curl --request GET \
    --get "/api/admin/servers/9/sync/accounts" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/9/sync/accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/9/sync/accounts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/9/sync/accounts'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Import service

Example request:

curl --request POST \
    "/api/admin/servers/14/sync/import-service" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"username\": \"rerum\",
    \"user_id\": 5,
    \"plan_id\": 18
}"

const url = new URL(
    "/api/admin/servers/14/sync/import-service"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "rerum",
    "user_id": 5,
    "plan_id": 18
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/14/sync/import-service';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'username' => 'rerum',
            'user_id' => 5,
            'plan_id' => 18,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/14/sync/import-service'
payload = {
    "username": "rerum",
    "user_id": 5,
    "plan_id": 18
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/servers/{id}/sync/import-service

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Server ID. Example: 14

Body Parameters

username string

Example: rerum

user_id integer

Example: 5

plan_id integer

Example: 18

Find WordPress installations

Example request:

curl --request GET \
    --get "/api/admin/servers/15/sync/find-applications" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/servers/15/sync/find-applications"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/15/sync/find-applications';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/15/sync/find-applications'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Import WordPress installation

Example request:

curl --request POST \
    "/api/admin/servers/16/sync/import-instance" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"username\": \"neque\",
    \"domain\": \"non\",
    \"path\": \"labore\",
    \"application\": \"voluptatem\"
}"

const url = new URL(
    "/api/admin/servers/16/sync/import-instance"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "neque",
    "domain": "non",
    "path": "labore",
    "application": "voluptatem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/servers/16/sync/import-instance';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'username' => 'neque',
            'domain' => 'non',
            'path' => 'labore',
            'application' => 'voluptatem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/servers/16/sync/import-instance'
payload = {
    "username": "neque",
    "domain": "non",
    "path": "labore",
    "application": "voluptatem"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/servers/{id}/sync/import-instance

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Server ID. Example: 16

Body Parameters

username string

Example: neque

domain string

Example: non

path string

Example: labore

application string optional

Example: voluptatem

List server groups

Example request:

curl --request GET \
    --get "/api/admin/server-groups" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/server-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/server-groups';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/server-groups'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show server group details

Example request:

curl --request GET \
    --get "/api/admin/server-groups/12" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/server-groups/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/server-groups/12';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/server-groups/12'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create server group

Example request:

curl --request POST \
    "/api/admin/server-groups" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"consectetur\",
    \"server_type\": \"aut\"
}"

const url = new URL(
    "/api/admin/server-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consectetur",
    "server_type": "aut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/server-groups';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'consectetur',
            'server_type' => 'aut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/server-groups'
payload = {
    "name": "consectetur",
    "server_type": "aut"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update server group

Example request:

curl --request PUT \
    "/api/admin/server-groups/5" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"cum\",
    \"server_type\": \"magni\"
}"

const url = new URL(
    "/api/admin/server-groups/5"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "cum",
    "server_type": "magni"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/server-groups/5';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'cum',
            'server_type' => 'magni',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/server-groups/5'
payload = {
    "name": "cum",
    "server_type": "magni"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/server-groups/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Server group ID. Example: 5

Body Parameters

name string

Example: cum

server_type string

Example: magni

servers object optional

Delete server group

Example request:

curl --request DELETE \
    "/api/admin/server-groups/12" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/server-groups/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/server-groups/12';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/server-groups/12'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

DNS Servers

Test connection

Example request:

curl --request POST \
    "/api/admin/dns-servers/test-connection" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"dolores\",
    \"type\": \"in\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/dns-servers/test-connection"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "dolores",
    "type": "in",
    "connection_config": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-servers/test-connection';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'dolores',
            'type' => 'in',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-servers/test-connection'
payload = {
    "name": "dolores",
    "type": "in",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List DNS server types

Example request:

curl --request GET \
    --get "/api/admin/dns-servers/types" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/dns-servers/types"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-servers/types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-servers/types'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List DNS servers

Example request:

curl --request GET \
    --get "/api/admin/dns-servers" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"type\": \"aut\"
}"

const url = new URL(
    "/api/admin/dns-servers"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "aut"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-servers';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'type' => 'aut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-servers'
payload = {
    "type": "aut"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show DNS server details

Example request:

curl --request GET \
    --get "/api/admin/dns-servers/19" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/dns-servers/19"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-servers/19';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-servers/19'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Add DNS server

Example request:

curl --request POST \
    "/api/admin/dns-servers" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"et\",
    \"type\": \"deleniti\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/dns-servers"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "et",
    "type": "deleniti",
    "connection_config": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-servers';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'et',
            'type' => 'deleniti',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-servers'
payload = {
    "name": "et",
    "type": "deleniti",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update DNS server

Example request:

curl --request PUT \
    "/api/admin/dns-servers/13" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"qui\",
    \"type\": \"sit\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/dns-servers/13"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "qui",
    "type": "sit",
    "connection_config": []
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-servers/13';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'qui',
            'type' => 'sit',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-servers/13'
payload = {
    "name": "qui",
    "type": "sit",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/dns-servers/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

DNS server ID. Example: 13

Body Parameters

name string

Example: qui

type string

Example: sit

connection_config object

Delete DNS server

Example request:

curl --request DELETE \
    "/api/admin/dns-servers/11" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/dns-servers/11"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-servers/11';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-servers/11'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List remote DNS zones

Example request:

curl --request GET \
    --get "/api/admin/dns-servers/10/sync/zones" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/dns-servers/10/sync/zones"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-servers/10/sync/zones';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-servers/10/sync/zones'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Import DNS zone

Example request:

curl --request POST \
    "/api/admin/dns-servers/13/sync/import-zone" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"pariatur\",
    \"service_id\": 8
}"

const url = new URL(
    "/api/admin/dns-servers/13/sync/import-zone"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "pariatur",
    "service_id": 8
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-servers/13/sync/import-zone';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'pariatur',
            'service_id' => 8,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-servers/13/sync/import-zone'
payload = {
    "name": "pariatur",
    "service_id": 8
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/dns-servers/{id}/sync/import-zone

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

DNS server ID. Example: 13

Body Parameters

name string

Example: pariatur

service_id integer

Example: 8

List DNS zone templates

Example request:

curl --request GET \
    --get "/api/admin/dns-zone-templates" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/dns-zone-templates"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-zone-templates';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-zone-templates'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create DNS zone template

Example request:

curl --request POST \
    "/api/admin/dns-zone-template" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"molestiae\",
    \"records\": [
        {
            \"name\": \"amet\",
            \"type\": \"CERT\",
            \"ttl\": 3,
            \"rdata\": \"nihil\"
        }
    ]
}"

const url = new URL(
    "/api/admin/dns-zone-template"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "molestiae",
    "records": [
        {
            "name": "amet",
            "type": "CERT",
            "ttl": 3,
            "rdata": "nihil"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-zone-template';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'molestiae',
            'records' => [
                [
                    'name' => 'amet',
                    'type' => 'CERT',
                    'ttl' => 3,
                    'rdata' => 'nihil',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-zone-template'
payload = {
    "name": "molestiae",
    "records": [
        {
            "name": "amet",
            "type": "CERT",
            "ttl": 3,
            "rdata": "nihil"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/dns-zone-template

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

name string

Example: molestiae

records object[] optional

name string

Example: amet

type string

Example: CERT

Must be one of:

A
AAAA
AFSDB
CAA
CERT
CNAME
DNAME
DNSKEY
DS
HINFO
HTTPS
LOC
NAPTR
PTR
RP
SMIMEA
SOA
SRV
SSHFP
SVCB
TLSA
URI
TXT
MX
NS

ttl integer

Example: 3

rdata string

Example: nihil

Update DNS zone template

Example request:

curl --request PUT \
    "/api/admin/dns-zone-template/20" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"cupiditate\",
    \"records\": [
        {
            \"name\": \"qui\",
            \"type\": \"HINFO\",
            \"ttl\": 7,
            \"rdata\": \"dolor\"
        }
    ]
}"

const url = new URL(
    "/api/admin/dns-zone-template/20"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "cupiditate",
    "records": [
        {
            "name": "qui",
            "type": "HINFO",
            "ttl": 7,
            "rdata": "dolor"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-zone-template/20';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'cupiditate',
            'records' => [
                [
                    'name' => 'qui',
                    'type' => 'HINFO',
                    'ttl' => 7,
                    'rdata' => 'dolor',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-zone-template/20'
payload = {
    "name": "cupiditate",
    "records": [
        {
            "name": "qui",
            "type": "HINFO",
            "ttl": 7,
            "rdata": "dolor"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/dns-zone-template/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Zone template ID. Example: 20

Body Parameters

name string

Example: cupiditate

records object[] optional

name string

Example: qui

type string

Example: HINFO

Must be one of:

A
AAAA
AFSDB
CAA
CERT
CNAME
DNAME
DNSKEY
DS
HINFO
HTTPS
LOC
NAPTR
PTR
RP
SMIMEA
SOA
SRV
SSHFP
SVCB
TLSA
URI
TXT
MX
NS

ttl integer

Example: 7

rdata string

Example: dolor

Delete zone template

Example request:

curl --request DELETE \
    "/api/admin/dns-zone-template/4" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/dns-zone-template/4"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-zone-template/4';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-zone-template/4'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List DNS zones

Example request:

curl --request GET \
    --get "/api/admin/dns-zones" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/dns-zones"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/dns-zones';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/dns-zones'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Email Servers

Test connection

Example request:

curl --request POST \
    "/api/admin/email-servers/test-connection" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"rerum\",
    \"type\": \"dolor\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/email-servers/test-connection"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "rerum",
    "type": "dolor",
    "connection_config": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers/test-connection';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'rerum',
            'type' => 'dolor',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers/test-connection'
payload = {
    "name": "rerum",
    "type": "dolor",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List email server types

Example request:

curl --request GET \
    --get "/api/admin/email-servers/types" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/email-servers/types"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers/types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers/types'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List email servers

Example request:

curl --request GET \
    --get "/api/admin/email-servers" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"type\": \"laudantium\"
}"

const url = new URL(
    "/api/admin/email-servers"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "laudantium"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'type' => 'laudantium',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers'
payload = {
    "type": "laudantium"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show email server details

Example request:

curl --request GET \
    --get "/api/admin/email-servers/et" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/email-servers/et"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers/et';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers/et'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show email server config

Example request:

curl --request GET \
    --get "/api/admin/email-servers/3/config" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/email-servers/3/config"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers/3/config';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers/3/config'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Add email server

Example request:

curl --request POST \
    "/api/admin/email-servers" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"rerum\",
    \"type\": \"repellat\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/email-servers"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "rerum",
    "type": "repellat",
    "connection_config": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'rerum',
            'type' => 'repellat',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers'
payload = {
    "name": "rerum",
    "type": "repellat",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update email server

Example request:

curl --request PUT \
    "/api/admin/email-servers/18" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"explicabo\",
    \"type\": \"cumque\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/email-servers/18"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "explicabo",
    "type": "cumque",
    "connection_config": []
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers/18';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'explicabo',
            'type' => 'cumque',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers/18'
payload = {
    "name": "explicabo",
    "type": "cumque",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/email-servers/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Email server ID. Example: 18

Body Parameters

name string

Example: explicabo

type string

Example: cumque

connection_config object

Delete email server

Example request:

curl --request DELETE \
    "/api/admin/email-servers/16" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/email-servers/16"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers/16';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers/16'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List remote email domains

Example request:

curl --request GET \
    --get "/api/admin/email-servers/est/sync/domains" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/email-servers/est/sync/domains"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers/est/sync/domains';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers/est/sync/domains'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Import email domain

Example request:

curl --request POST \
    "/api/admin/email-servers/fugiat/sync/import-domain" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"dolorem\",
    \"service_id\": 16
}"

const url = new URL(
    "/api/admin/email-servers/fugiat/sync/import-domain"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "dolorem",
    "service_id": 16
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/email-servers/fugiat/sync/import-domain';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'dolorem',
            'service_id' => 16,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/email-servers/fugiat/sync/import-domain'
payload = {
    "name": "dolorem",
    "service_id": 16
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/email-servers/{id}/sync/import-domain

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id string

The ID of the email server. Example: fugiat

Body Parameters

name string

Example: dolorem

service_id integer

Example: 16

Remote Backups

List remote backup types

Example request:

curl --request GET \
    --get "/api/admin/remote-backups/types" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/remote-backups/types"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/remote-backups/types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/remote-backups/types'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Test connection

Example request:

curl --request POST \
    "/api/admin/remote-backups/test-connection" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"commodi\",
    \"type\": \"soluta\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/remote-backups/test-connection"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "commodi",
    "type": "soluta",
    "connection_config": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/remote-backups/test-connection';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'commodi',
            'type' => 'soluta',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/remote-backups/test-connection'
payload = {
    "name": "commodi",
    "type": "soluta",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List remote backup connections

Example request:

curl --request GET \
    --get "/api/admin/remote-backups" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/remote-backups"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/remote-backups';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/remote-backups'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Add remote backup connection

Example request:

curl --request POST \
    "/api/admin/remote-backups" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"fuga\",
    \"type\": \"fuga\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/remote-backups"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "fuga",
    "type": "fuga",
    "connection_config": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/remote-backups';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'fuga',
            'type' => 'fuga',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/remote-backups'
payload = {
    "name": "fuga",
    "type": "fuga",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update remote backup connection

Example request:

curl --request PUT \
    "/api/admin/remote-backups/7" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"distinctio\",
    \"type\": \"esse\",
    \"connection_config\": []
}"

const url = new URL(
    "/api/admin/remote-backups/7"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "distinctio",
    "type": "esse",
    "connection_config": []
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/remote-backups/7';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'distinctio',
            'type' => 'esse',
            'connection_config' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/remote-backups/7'
payload = {
    "name": "distinctio",
    "type": "esse",
    "connection_config": []
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/remote-backups/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Remote backup connection ID. Example: 7

Body Parameters

name string

Example: distinctio

type string

Example: esse

connection_config object

Delete remote backup connection

Example request:

curl --request DELETE \
    "/api/admin/remote-backups/8" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/remote-backups/8"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/remote-backups/8';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/remote-backups/8'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List backup containers

Example request:

curl --request GET \
    --get "/api/admin/backup-containers" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/backup-containers"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/backup-containers';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/backup-containers'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create backup container

Example request:

curl --request POST \
    "/api/admin/backup-containers" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"remote_backup_id\": 2,
    \"name\": \"sequi\",
    \"location\": \"laboriosam\",
    \"is_local_storage\": true,
    \"max_size_backups_per_site\": 11,
    \"max_number_backups_per_site\": 8,
    \"backup_type\": \"full\"
}"

const url = new URL(
    "/api/admin/backup-containers"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "remote_backup_id": 2,
    "name": "sequi",
    "location": "laboriosam",
    "is_local_storage": true,
    "max_size_backups_per_site": 11,
    "max_number_backups_per_site": 8,
    "backup_type": "full"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/backup-containers';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'remote_backup_id' => 2,
            'name' => 'sequi',
            'location' => 'laboriosam',
            'is_local_storage' => true,
            'max_size_backups_per_site' => 11,
            'max_number_backups_per_site' => 8,
            'backup_type' => 'full',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/backup-containers'
payload = {
    "remote_backup_id": 2,
    "name": "sequi",
    "location": "laboriosam",
    "is_local_storage": true,
    "max_size_backups_per_site": 11,
    "max_number_backups_per_site": 8,
    "backup_type": "full"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/backup-containers

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

remote_backup_id integer

Example: 2

name string

Example: sequi

location string

Example: laboriosam

is_local_storage boolean true false

Example: true

max_size_backups_per_site integer

Example: 11

max_number_backups_per_site integer

Example: 8

backup_type string

Example: full

Must be one of:

full
incremental

backup_type_rules object optional

rules object optional

Update backup container

Example request:

curl --request PUT \
    "/api/admin/backup-containers/14" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"remote_backup_id\": 10,
    \"name\": \"voluptatum\",
    \"location\": \"minus\",
    \"is_local_storage\": true,
    \"max_size_backups_per_site\": 5,
    \"max_number_backups_per_site\": 18,
    \"backup_type\": \"full\"
}"

const url = new URL(
    "/api/admin/backup-containers/14"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "remote_backup_id": 10,
    "name": "voluptatum",
    "location": "minus",
    "is_local_storage": true,
    "max_size_backups_per_site": 5,
    "max_number_backups_per_site": 18,
    "backup_type": "full"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/backup-containers/14';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'remote_backup_id' => 10,
            'name' => 'voluptatum',
            'location' => 'minus',
            'is_local_storage' => true,
            'max_size_backups_per_site' => 5,
            'max_number_backups_per_site' => 18,
            'backup_type' => 'full',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/backup-containers/14'
payload = {
    "remote_backup_id": 10,
    "name": "voluptatum",
    "location": "minus",
    "is_local_storage": true,
    "max_size_backups_per_site": 5,
    "max_number_backups_per_site": 18,
    "backup_type": "full"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/backup-containers/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Backup container ID. Example: 14

Body Parameters

remote_backup_id integer

Example: 10

name string

Example: voluptatum

location string

Example: minus

is_local_storage boolean true false

Example: true

max_size_backups_per_site integer

Example: 5

max_number_backups_per_site integer

Example: 18

backup_type string

Example: full

Must be one of:

full
incremental

backup_type_rules object optional

rules object optional

Delete backup container ID

Example request:

curl --request DELETE \
    "/api/admin/backup-containers/7" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/backup-containers/7"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/backup-containers/7';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/backup-containers/7'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update backup container rules

Example request:

curl --request PUT \
    "/api/admin/backup-containers/3/rules" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"*\": {
        \"type\": \"service\",
        \"values\": [
            13
        ]
    }
}"

const url = new URL(
    "/api/admin/backup-containers/3/rules"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "*": {
        "type": "service",
        "values": [
            13
        ]
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/backup-containers/3/rules';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            '*' => [
                'type' => 'service',
                'values' => [
                    13,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/backup-containers/3/rules'
payload = {
    "*": {
        "type": "service",
        "values": [
            13
        ]
    }
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/backup-containers/{id}/rules

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Backup container ID. Example: 3

Body Parameters

* object

type string

Example: service

Must be one of:

instance
service
client
plan
server
server_group

values integer[]

List backup logs

Example request:

curl --request GET \
    --get "/api/admin/backup-logs" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"search_term\": \"debitis\",
    \"plan_id\": 8,
    \"server_id\": 14,
    \"instance_id\": 7,
    \"container_id\": 4,
    \"remote_backup_id\": 16
}"

const url = new URL(
    "/api/admin/backup-logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search_term": "debitis",
    "plan_id": 8,
    "server_id": 14,
    "instance_id": 7,
    "container_id": 4,
    "remote_backup_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/backup-logs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'search_term' => 'debitis',
            'plan_id' => 8,
            'server_id' => 14,
            'instance_id' => 7,
            'container_id' => 4,
            'remote_backup_id' => 16,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/backup-logs'
payload = {
    "search_term": "debitis",
    "plan_id": 8,
    "server_id": 14,
    "instance_id": 7,
    "container_id": 4,
    "remote_backup_id": 16
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/admin/backup-logs

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

search_term string optional

Example: debitis

plan_id integer optional

Example: 8

server_id integer optional

Example: 14

instance_id integer optional

Example: 7

container_id integer optional

Example: 4

remote_backup_id integer optional

Example: 16

Plans

List plans

Example request:

curl --request GET \
    --get "/api/admin/plans" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/plans"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/plans';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/plans'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create plan

Example request:

curl --request POST \
    "/api/admin/plans" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"et\",
    \"application_limit\": 11,
    \"server_type\": \"quis\",
    \"server_group_id\": 12,
    \"server_assign_rule\": \"least_accounts\",
    \"server_id\": 13,
    \"remote_suspend\": false,
    \"dns_server_internal\": true,
    \"dns_server_type\": \"perferendis\",
    \"dns_server_id\": 5,
    \"dns_zone_template_id\": 3,
    \"email_server_internal\": false,
    \"email_server_type\": \"similique\",
    \"email_server_id\": 9,
    \"config\": {
        \"onboarding\": {
            \"redirect_delay_after_site_creation\": 1
        }
    },
    \"scan_interval\": 3,
    \"is_automatic_backups_enabled\": true,
    \"is_automatic_backups_editable\": false,
    \"automatic_backups_frequency\": \"monthly\"
}"

const url = new URL(
    "/api/admin/plans"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "et",
    "application_limit": 11,
    "server_type": "quis",
    "server_group_id": 12,
    "server_assign_rule": "least_accounts",
    "server_id": 13,
    "remote_suspend": false,
    "dns_server_internal": true,
    "dns_server_type": "perferendis",
    "dns_server_id": 5,
    "dns_zone_template_id": 3,
    "email_server_internal": false,
    "email_server_type": "similique",
    "email_server_id": 9,
    "config": {
        "onboarding": {
            "redirect_delay_after_site_creation": 1
        }
    },
    "scan_interval": 3,
    "is_automatic_backups_enabled": true,
    "is_automatic_backups_editable": false,
    "automatic_backups_frequency": "monthly"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/plans';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'et',
            'application_limit' => 11,
            'server_type' => 'quis',
            'server_group_id' => 12,
            'server_assign_rule' => 'least_accounts',
            'server_id' => 13,
            'remote_suspend' => false,
            'dns_server_internal' => true,
            'dns_server_type' => 'perferendis',
            'dns_server_id' => 5,
            'dns_zone_template_id' => 3,
            'email_server_internal' => false,
            'email_server_type' => 'similique',
            'email_server_id' => 9,
            'config' => [
                'onboarding' => [
                    'redirect_delay_after_site_creation' => 1,
                ],
            ],
            'scan_interval' => 3,
            'is_automatic_backups_enabled' => true,
            'is_automatic_backups_editable' => false,
            'automatic_backups_frequency' => 'monthly',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/plans'
payload = {
    "name": "et",
    "application_limit": 11,
    "server_type": "quis",
    "server_group_id": 12,
    "server_assign_rule": "least_accounts",
    "server_id": 13,
    "remote_suspend": false,
    "dns_server_internal": true,
    "dns_server_type": "perferendis",
    "dns_server_id": 5,
    "dns_zone_template_id": 3,
    "email_server_internal": false,
    "email_server_type": "similique",
    "email_server_id": 9,
    "config": {
        "onboarding": {
            "redirect_delay_after_site_creation": 1
        }
    },
    "scan_interval": 3,
    "is_automatic_backups_enabled": true,
    "is_automatic_backups_editable": false,
    "automatic_backups_frequency": "monthly"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/plans

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

name string

Example: et

application_limit integer

Example: 11

server_type string

Example: quis

server_group_id integer optional

Example: 12

server_assign_rule string optional

Example: least_accounts

Must be one of:

random
least_accounts
specific_server

server_id integer optional

Example: 13

account_config object optional

remote_suspend boolean optional true false

Example: false

dns_server_internal boolean optional true false

Example: true

dns_server_type string optional

Example: perferendis

dns_server_id integer optional

Example: 5

dns_account_config object optional

dns_zone_template_id integer optional

Example: 3

email_server_internal boolean optional true false

Example: false

email_server_type string optional

Example: similique

email_server_id integer optional

Example: 9

email_account_config object optional

config object optional

onboarding object optional

redirect_delay_after_site_creation integer optional

Example: 1

packages object optional

automatic_install_plugins object optional

automatic_install_themes object optional

blacklist_plugins object optional

delete_blacklisted_plugins object optional

delete_blacklisted_themes object optional

scan_interval integer

Example: 3

is_automatic_backups_enabled boolean optional true false

Example: true

is_automatic_backups_editable boolean optional true false

Example: false

automatic_backups_frequency string optional

Example: monthly

Must be one of:

daily
weekly
monthly

Test plan configuration

Example request:

curl --request POST \
    "/api/admin/plans/test-config" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/plans/test-config"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/plans/test-config';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/plans/test-config'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show plan details

Example request:

curl --request GET \
    --get "/api/admin/plans/16" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/plans/16"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/plans/16';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/plans/16'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update plan

Example request:

curl --request PUT \
    "/api/admin/plans/17" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"dolorem\",
    \"application_limit\": 12,
    \"server_type\": \"distinctio\",
    \"server_group_id\": 3,
    \"server_assign_rule\": \"random\",
    \"server_id\": 20,
    \"remote_suspend\": true,
    \"dns_server_internal\": true,
    \"dns_server_type\": \"laudantium\",
    \"dns_server_id\": 17,
    \"dns_zone_template_id\": 5,
    \"email_server_internal\": false,
    \"email_server_type\": \"hic\",
    \"email_server_id\": 19,
    \"config\": {
        \"onboarding\": {
            \"redirect_delay_after_site_creation\": 2
        }
    },
    \"scan_interval\": 17,
    \"is_automatic_backups_enabled\": false,
    \"is_automatic_backups_editable\": false,
    \"automatic_backups_frequency\": \"daily\"
}"

const url = new URL(
    "/api/admin/plans/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "dolorem",
    "application_limit": 12,
    "server_type": "distinctio",
    "server_group_id": 3,
    "server_assign_rule": "random",
    "server_id": 20,
    "remote_suspend": true,
    "dns_server_internal": true,
    "dns_server_type": "laudantium",
    "dns_server_id": 17,
    "dns_zone_template_id": 5,
    "email_server_internal": false,
    "email_server_type": "hic",
    "email_server_id": 19,
    "config": {
        "onboarding": {
            "redirect_delay_after_site_creation": 2
        }
    },
    "scan_interval": 17,
    "is_automatic_backups_enabled": false,
    "is_automatic_backups_editable": false,
    "automatic_backups_frequency": "daily"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/plans/17';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'dolorem',
            'application_limit' => 12,
            'server_type' => 'distinctio',
            'server_group_id' => 3,
            'server_assign_rule' => 'random',
            'server_id' => 20,
            'remote_suspend' => true,
            'dns_server_internal' => true,
            'dns_server_type' => 'laudantium',
            'dns_server_id' => 17,
            'dns_zone_template_id' => 5,
            'email_server_internal' => false,
            'email_server_type' => 'hic',
            'email_server_id' => 19,
            'config' => [
                'onboarding' => [
                    'redirect_delay_after_site_creation' => 2,
                ],
            ],
            'scan_interval' => 17,
            'is_automatic_backups_enabled' => false,
            'is_automatic_backups_editable' => false,
            'automatic_backups_frequency' => 'daily',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/plans/17'
payload = {
    "name": "dolorem",
    "application_limit": 12,
    "server_type": "distinctio",
    "server_group_id": 3,
    "server_assign_rule": "random",
    "server_id": 20,
    "remote_suspend": true,
    "dns_server_internal": true,
    "dns_server_type": "laudantium",
    "dns_server_id": 17,
    "dns_zone_template_id": 5,
    "email_server_internal": false,
    "email_server_type": "hic",
    "email_server_id": 19,
    "config": {
        "onboarding": {
            "redirect_delay_after_site_creation": 2
        }
    },
    "scan_interval": 17,
    "is_automatic_backups_enabled": false,
    "is_automatic_backups_editable": false,
    "automatic_backups_frequency": "daily"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/plans/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Plan ID. Example: 17

Body Parameters

name string

Example: dolorem

application_limit integer

Example: 12

server_type string

Example: distinctio

server_group_id integer optional

Example: 3

server_assign_rule string optional

Example: random

Must be one of:

random
least_accounts
specific_server

server_id integer optional

Example: 20

account_config object optional

remote_suspend boolean optional true false

Example: true

dns_server_internal boolean optional true false

Example: true

dns_server_type string optional

Example: laudantium

dns_server_id integer optional

Example: 17

dns_account_config object optional

dns_zone_template_id integer optional

Example: 5

email_server_internal boolean optional true false

Example: false

email_server_type string optional

Example: hic

email_server_id integer optional

Example: 19

email_account_config object optional

config object optional

onboarding object optional

redirect_delay_after_site_creation integer optional

Example: 2

packages object optional

automatic_install_plugins object optional

automatic_install_themes object optional

blacklist_plugins object optional

delete_blacklisted_plugins object optional

delete_blacklisted_themes object optional

scan_interval integer

Example: 17

is_automatic_backups_enabled boolean optional true false

Example: false

is_automatic_backups_editable boolean optional true false

Example: false

automatic_backups_frequency string optional

Example: daily

Must be one of:

daily
weekly
monthly

Delete plan

Example request:

curl --request DELETE \
    "/api/admin/plans/17" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/plans/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/plans/17';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/plans/17'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Duplicate plan

Example request:

curl --request POST \
    "/api/admin/plans/11/duplicate" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"modi\"
}"

const url = new URL(
    "/api/admin/plans/11/duplicate"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "modi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/plans/11/duplicate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'modi',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/plans/11/duplicate'
payload = {
    "name": "modi"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Instances

List instances

Example request:

curl --request GET \
    --get "/api/admin/instances" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"filter\": \"sed\",
    \"user_id\": 5,
    \"hosting_account_id\": 8,
    \"plan_id\": 1,
    \"service_id\": 5,
    \"server_id\": 14,
    \"status\": \"qui\",
    \"trials_only\": \"animi\"
}"

const url = new URL(
    "/api/admin/instances"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filter": "sed",
    "user_id": 5,
    "hosting_account_id": 8,
    "plan_id": 1,
    "service_id": 5,
    "server_id": 14,
    "status": "qui",
    "trials_only": "animi"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'filter' => 'sed',
            'user_id' => 5,
            'hosting_account_id' => 8,
            'plan_id' => 1,
            'service_id' => 5,
            'server_id' => 14,
            'status' => 'qui',
            'trials_only' => 'animi',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances'
payload = {
    "filter": "sed",
    "user_id": 5,
    "hosting_account_id": 8,
    "plan_id": 1,
    "service_id": 5,
    "server_id": 14,
    "status": "qui",
    "trials_only": "animi"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/admin/instances

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

filter string optional

Example: sed

user_id integer optional

Example: 5

hosting_account_id integer optional

Example: 8

plan_id integer optional

Example: 1

service_id integer optional

Example: 5

server_id integer optional

Example: 14

status string optional

Example: qui

trials_only string optional

Example: animi

List failed instances

Example request:

curl --request GET \
    --get "/api/admin/instances/failed" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"filter\": \"necessitatibus\",
    \"hosting_account_id\": 15,
    \"plan_id\": 13,
    \"service_id\": 20,
    \"server_id\": 2
}"

const url = new URL(
    "/api/admin/instances/failed"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filter": "necessitatibus",
    "hosting_account_id": 15,
    "plan_id": 13,
    "service_id": 20,
    "server_id": 2
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/failed';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'filter' => 'necessitatibus',
            'hosting_account_id' => 15,
            'plan_id' => 13,
            'service_id' => 20,
            'server_id' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/failed'
payload = {
    "filter": "necessitatibus",
    "hosting_account_id": 15,
    "plan_id": 13,
    "service_id": 20,
    "server_id": 2
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/admin/instances/failed

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

filter string optional

Example: necessitatibus

hosting_account_id integer optional

Example: 15

plan_id integer optional

Example: 13

service_id integer optional

Example: 20

server_id integer optional

Example: 2

Show failed instance details

Example request:

curl --request GET \
    --get "/api/admin/instances/failed/18" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/instances/failed/18"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/failed/18';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/failed/18'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete failed instance

Example request:

curl --request DELETE \
    "/api/admin/instances/failed/15" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/instances/failed/15"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/failed/15';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/failed/15'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Retry install failed instance

Example request:

curl --request PUT \
    "/api/admin/instances/failed/6/retry" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/instances/failed/6/retry"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/failed/6/retry';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/failed/6/retry'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List archived instances

Example request:

curl --request GET \
    --get "/api/admin/instances/archived" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"filter\": \"veniam\",
    \"user_id\": 17,
    \"hosting_account_id\": 16,
    \"plan_id\": 3,
    \"service_id\": 17,
    \"server_id\": 3
}"

const url = new URL(
    "/api/admin/instances/archived"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filter": "veniam",
    "user_id": 17,
    "hosting_account_id": 16,
    "plan_id": 3,
    "service_id": 17,
    "server_id": 3
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/archived';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'filter' => 'veniam',
            'user_id' => 17,
            'hosting_account_id' => 16,
            'plan_id' => 3,
            'service_id' => 17,
            'server_id' => 3,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/archived'
payload = {
    "filter": "veniam",
    "user_id": 17,
    "hosting_account_id": 16,
    "plan_id": 3,
    "service_id": 17,
    "server_id": 3
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/admin/instances/archived

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

filter string optional

Example: veniam

user_id integer optional

Example: 17

hosting_account_id integer optional

Example: 16

plan_id integer optional

Example: 3

service_id integer optional

Example: 17

server_id integer optional

Example: 3

Show archived instance details

Example request:

curl --request GET \
    --get "/api/admin/instances/archived/8" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/instances/archived/8"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/archived/8';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/archived/8'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete archived instance

Example request:

curl --request DELETE \
    "/api/admin/instances/archived/6/delete" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/instances/archived/6/delete"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/archived/6/delete';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/archived/6/delete'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show instance details

Example request:

curl --request GET \
    --get "/api/admin/instances/6" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/instances/6"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/6';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/6'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete instance

Example request:

curl --request DELETE \
    "/api/admin/instances/8" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"remove_data\": false,
    \"remove_database\": false
}"

const url = new URL(
    "/api/admin/instances/8"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "remove_data": false,
    "remove_database": false
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/8';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'remove_data' => false,
            'remove_database' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/8'
payload = {
    "remove_data": false,
    "remove_database": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/admin/instances/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 8

Body Parameters

remove_data boolean optional true false

Example: false

remove_database boolean optional true false

Example: false

List WordPress users

Example request:

curl --request GET \
    --get "/api/admin/instances/11/wordpress/users" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/instances/11/wordpress/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/11/wordpress/users';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/11/wordpress/users'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create WordPress SSO URL

Example request:

curl --request POST \
    "/api/admin/instances/15/wordpress/sso-url" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"user\": 17
}"

const url = new URL(
    "/api/admin/instances/15/wordpress/sso-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instances/15/wordpress/sso-url';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'user' => 17,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instances/15/wordpress/sso-url'
payload = {
    "user": 17
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Services

List services

Example request:

curl --request GET \
    --get "/api/admin/services" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"search_term\": \"qui\",
    \"user_id\": 7,
    \"plan_id\": 12,
    \"archived\": true,
    \"filter_by\": \"trials\",
    \"status\": \"sit\"
}"

const url = new URL(
    "/api/admin/services"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search_term": "qui",
    "user_id": 7,
    "plan_id": 12,
    "archived": true,
    "filter_by": "trials",
    "status": "sit"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'search_term' => 'qui',
            'user_id' => 7,
            'plan_id' => 12,
            'archived' => true,
            'filter_by' => 'trials',
            'status' => 'sit',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services'
payload = {
    "search_term": "qui",
    "user_id": 7,
    "plan_id": 12,
    "archived": true,
    "filter_by": "trials",
    "status": "sit"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/admin/services

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

search_term string optional

Example: qui

user_id integer optional

Example: 7

plan_id integer optional

Example: 12

archived boolean optional true false

Example: true

filter_by string optional

Example: trials

Must be one of:

trials
pre_created
trial_conversions
trial_cancellations
paid_cancellations

status string optional

Example: sit

List archived services

Example request:

curl --request GET \
    --get "/api/admin/services/archived" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"search_term\": \"consequuntur\",
    \"user_id\": 1
}"

const url = new URL(
    "/api/admin/services/archived"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search_term": "consequuntur",
    "user_id": 1
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services/archived';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'search_term' => 'consequuntur',
            'user_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services/archived'
payload = {
    "search_term": "consequuntur",
    "user_id": 1
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show statistics of all services

Example request:

curl --request GET \
    --get "/api/admin/services/stats" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/services/stats"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services/stats';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services/stats'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show service details

Example request:

curl --request GET \
    --get "/api/admin/services/4" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/services/4"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services/4';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services/4'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show archived service details

Example request:

curl --request GET \
    --get "/api/admin/services/20/archived" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/services/20/archived"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services/20/archived';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services/20/archived'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show service statistics

Example request:

curl --request GET \
    --get "/api/admin/services/4/stats" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/services/4/stats"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services/4/stats';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services/4/stats'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Change owner of service

Example request:

curl --request PUT \
    "/api/admin/services/16/change-owner" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"user_id\": 17
}"

const url = new URL(
    "/api/admin/services/16/change-owner"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 17
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services/16/change-owner';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'user_id' => 17,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services/16/change-owner'
payload = {
    "user_id": 17
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Add package to service

Example request:

curl --request POST \
    "/api/admin/service/12/package" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"package_id\": 3
}"

const url = new URL(
    "/api/admin/service/12/package"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "package_id": 3
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/service/12/package';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'package_id' => 3,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/service/12/package'
payload = {
    "package_id": 3
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete package from service

Example request:

curl --request DELETE \
    "/api/admin/service/6/package/dolorem" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/service/6/package/dolorem"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/service/6/package/dolorem';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/service/6/package/dolorem'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete service

Example request:

curl --request DELETE \
    "/api/admin/services/17" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"force_termination\": false
}"

const url = new URL(
    "/api/admin/services/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "force_termination": false
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services/17';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'force_termination' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services/17'
payload = {
    "force_termination": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/admin/services/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Service ID. Example: 17

Body Parameters

force_termination boolean optional true false

Example: false

Delete archived service

Example request:

curl --request DELETE \
    "/api/admin/services/19/delete" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/services/19/delete"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services/19/delete';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services/19/delete'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Edit trial settings for the service

Example request:

curl --request PUT \
    "/api/admin/services/16/trial-settings" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"is_trial\": true,
    \"trial_expiry_at\": \"2025-05-20 08:38:21\"
}"

const url = new URL(
    "/api/admin/services/16/trial-settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "is_trial": true,
    "trial_expiry_at": "2025-05-20 08:38:21"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/services/16/trial-settings';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'is_trial' => true,
            'trial_expiry_at' => '2025-05-20 08:38:21',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/services/16/trial-settings'
payload = {
    "is_trial": true,
    "trial_expiry_at": "2025-05-20 08:38:21"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/services/{id}/trial-settings

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Service ID. Example: 16

Body Parameters

is_trial boolean true false

Example: true

trial_expiry_at string

Must be a valid date in the format Y-m-d H:i:s. Example: 2025-05-20 08:38:21

Hosting Accounts

Show hosting account details

Example request:

curl --request GET \
    --get "/api/admin/hosting-accounts/11" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/hosting-accounts/11"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/hosting-accounts/11';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/hosting-accounts/11'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List hosting account domains

Example request:

curl --request GET \
    --get "/api/admin/hosting-accounts/5/domains" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/hosting-accounts/5/domains"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/hosting-accounts/5/domains';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/hosting-accounts/5/domains'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get installed SSL certificate

Example request:

curl --request GET \
    --get "/api/admin/hosting-accounts/6/installed-ssl-cert/nihil" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/hosting-accounts/6/installed-ssl-cert/nihil"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/hosting-accounts/6/installed-ssl-cert/nihil';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/hosting-accounts/6/installed-ssl-cert/nihil'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get detected SSL certificate

Example request:

curl --request GET \
    --get "/api/admin/hosting-accounts/17/detected-ssl-cert/fuga" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/hosting-accounts/17/detected-ssl-cert/fuga"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/hosting-accounts/17/detected-ssl-cert/fuga';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/hosting-accounts/17/detected-ssl-cert/fuga'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show hosting account usage

Example request:

curl --request GET \
    --get "/api/admin/hosting-accounts/8/usage" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/hosting-accounts/8/usage"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/hosting-accounts/8/usage';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/hosting-accounts/8/usage'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Reinstall hosting account

Example request:

curl --request PUT \
    "/api/admin/hosting-accounts/10/reinstall" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/hosting-accounts/10/reinstall"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/hosting-accounts/10/reinstall';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/hosting-accounts/10/reinstall'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Notifications

Get list of notification templates assigned to recipient

Example request:

curl --request GET \
    --get "/api/admin/notification-templates/mollitia" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"filter\": \"aspernatur\"
}"

const url = new URL(
    "/api/admin/notification-templates/mollitia"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filter": "aspernatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/notification-templates/mollitia';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'filter' => 'aspernatur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/notification-templates/mollitia'
payload = {
    "filter": "aspernatur"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get single notification template to edit

Example request:

curl --request GET \
    --get "/api/admin/notification-template/debitis" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/notification-template/debitis"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/notification-template/debitis';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/notification-template/debitis'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update notification template

Example request:

curl --request PUT \
    "/api/admin/notification-template/voluptatem/update" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"messages\": [
        {
            \"message\": \"odit\",
            \"subject\": \"sit\"
        }
    ]
}"

const url = new URL(
    "/api/admin/notification-template/voluptatem/update"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "messages": [
        {
            "message": "odit",
            "subject": "sit"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/notification-template/voluptatem/update';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'messages' => [
                [
                    'message' => 'odit',
                    'subject' => 'sit',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/notification-template/voluptatem/update'
payload = {
    "messages": [
        {
            "message": "odit",
            "subject": "sit"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/notification-template/{id}/update

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id string

The ID of the notification template. Example: voluptatem

Body Parameters

messages object[] optional

message string optional

Example: odit

subject string optional

Example: sit

Show preview of email

Example request:

curl --request POST \
    "/api/admin/notification-template/preview" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/notification-template/preview"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/notification-template/preview';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/notification-template/preview'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Send test email

Example request:

curl --request GET \
    --get "/api/admin/notification-template/consequatur/test" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/notification-template/consequatur/test"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/notification-template/consequatur/test';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/notification-template/consequatur/test'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Change notification template status

Example request:

curl --request PUT \
    "/api/admin/notification-template/vitae/status" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"enabled\": true
}"

const url = new URL(
    "/api/admin/notification-template/vitae/status"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "enabled": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/notification-template/vitae/status';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'enabled' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/notification-template/vitae/status'
payload = {
    "enabled": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/notification-template/{id}/status

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id string

The ID of the notification template. Example: vitae

Body Parameters

enabled boolean true false

Example: true

Restore notification message to default

Example request:

curl --request POST \
    "/api/admin/notification-template/eaque/restore" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/notification-template/eaque/restore"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/notification-template/eaque/restore';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/notification-template/eaque/restore'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show email settings

Example request:

curl --request GET \
    --get "/api/admin/notifications/settings" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/notifications/settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/notifications/settings';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/notifications/settings'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update email settings

Example request:

curl --request PUT \
    "/api/admin/notifications/settings" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/notifications/settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/notifications/settings';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/notifications/settings'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Admin Groups

List admin group types

Example request:

curl --request GET \
    --get "/api/admin/admin-groups/types" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/admin-groups/types"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admin-groups/types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admin-groups/types'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List admin groups

Example request:

curl --request GET \
    --get "/api/admin/admin-groups" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/admin-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admin-groups';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admin-groups'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List admin group permissions and notifications

Example request:

curl --request GET \
    --get "/api/admin/admin-groups/permissions" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/admin-groups/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admin-groups/permissions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admin-groups/permissions'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show admin group details

Example request:

curl --request GET \
    --get "/api/admin/admin-groups/12" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/admin-groups/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admin-groups/12';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admin-groups/12'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create admin group

Example request:

curl --request POST \
    "/api/admin/admin-group" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"incidunt\"
}"

const url = new URL(
    "/api/admin/admin-group"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "incidunt"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admin-group';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'incidunt',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admin-group'
payload = {
    "name": "incidunt"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update admin group

Example request:

curl --request PUT \
    "/api/admin/admin-group/3" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"voluptate\"
}"

const url = new URL(
    "/api/admin/admin-group/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "voluptate"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admin-group/3';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'voluptate',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admin-group/3'
payload = {
    "name": "voluptate"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/admin-group/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Admin Group ID. Example: 3

Body Parameters

name string

Example: voluptate

permissions object optional

notifications object optional

Delete admin group

Example request:

curl --request DELETE \
    "/api/admin/admin-group/3" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/admin-group/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/admin-group/3';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/admin-group/3'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Tasks

List tasks

Example request:

curl --request GET \
    --get "/api/admin/tasks" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"search_term\": \"aspernatur\",
    \"date_range\": \"soluta\",
    \"filter_types\": \"commodi\",
    \"filter_statuses\": \"molestiae\"
}"

const url = new URL(
    "/api/admin/tasks"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search_term": "aspernatur",
    "date_range": "soluta",
    "filter_types": "commodi",
    "filter_statuses": "molestiae"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/tasks';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'search_term' => 'aspernatur',
            'date_range' => 'soluta',
            'filter_types' => 'commodi',
            'filter_statuses' => 'molestiae',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/tasks'
payload = {
    "search_term": "aspernatur",
    "date_range": "soluta",
    "filter_types": "commodi",
    "filter_statuses": "molestiae"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/admin/tasks

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

search_term string optional

Example: aspernatur

date_range string optional

Example: soluta

filter_types string optional

Example: commodi

filter_statuses string optional

Example: molestiae

List running tasks

Example request:

curl --request GET \
    --get "/api/admin/tasks/running" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/tasks/running"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/tasks/running';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/tasks/running'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Cancel task

Example request:

curl --request DELETE \
    "/api/admin/tasks/12/cancel" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/tasks/12/cancel"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/tasks/12/cancel';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/tasks/12/cancel'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Check worker status

Example request:

curl --request GET \
    --get "/api/admin/tasks/worker-status" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/tasks/worker-status"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/tasks/worker-status';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/tasks/worker-status'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Check task status

Example request:

curl --request GET \
    --get "/api/admin/tasks/10/status" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/tasks/10/status"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/tasks/10/status';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/tasks/10/status'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Retry task

Example request:

curl --request GET \
    --get "/api/admin/tasks/17/retry" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/tasks/17/retry"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/tasks/17/retry';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/tasks/17/retry'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

WordPress Plugins and Themes

List theme categories

Example request:

curl --request GET \
    --get "/api/admin/theme-categories" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/theme-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/theme-categories';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/theme-categories'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create theme category

Example request:

curl --request POST \
    "/api/admin/theme-category" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"asperiores\"
}"

const url = new URL(
    "/api/admin/theme-category"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "asperiores"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/theme-category';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'asperiores',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/theme-category'
payload = {
    "name": "asperiores"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete theme category

Example request:

curl --request DELETE \
    "/api/admin/theme-category/3" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/theme-category/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/theme-category/3';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/theme-category/3'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List themes from category

Example request:

curl --request GET \
    --get "/api/admin/theme-category/11/themes" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/theme-category/11/themes"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/theme-category/11/themes';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/theme-category/11/themes'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update theme category

Example request:

curl --request PUT \
    "/api/admin/theme-category/20/update" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"pariatur\"
}"

const url = new URL(
    "/api/admin/theme-category/20/update"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "pariatur"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/theme-category/20/update';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'pariatur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/theme-category/20/update'
payload = {
    "name": "pariatur"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete theme from category

Example request:

curl --request DELETE \
    "/api/admin/theme-category/20/delete-theme/officiis" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/theme-category/20/delete-theme/officiis"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/theme-category/20/delete-theme/officiis';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/theme-category/20/delete-theme/officiis'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Add theme to category

Example request:

curl --request POST \
    "/api/admin/theme-category/2/add-theme" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"assumenda\",
    \"slug\": \"esp-wam_k\",
    \"description\": \"Odio laudantium sed soluta perspiciatis.\",
    \"screenshot_url\": \"http:\\/\\/www.huel.com\\/voluptates-saepe-reiciendis-ipsam-ducimus-nemo-molestiae-at\",
    \"preview_url\": \"http:\\/\\/www.kub.com\\/aspernatur-pariatur-aliquid-voluptas-dolorem-fugit-voluptatibus-aperiam\",
    \"homepage\": \"quis\"
}"

const url = new URL(
    "/api/admin/theme-category/2/add-theme"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "assumenda",
    "slug": "esp-wam_k",
    "description": "Odio laudantium sed soluta perspiciatis.",
    "screenshot_url": "http:\/\/www.huel.com\/voluptates-saepe-reiciendis-ipsam-ducimus-nemo-molestiae-at",
    "preview_url": "http:\/\/www.kub.com\/aspernatur-pariatur-aliquid-voluptas-dolorem-fugit-voluptatibus-aperiam",
    "homepage": "quis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/theme-category/2/add-theme';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'assumenda',
            'slug' => 'esp-wam_k',
            'description' => 'Odio laudantium sed soluta perspiciatis.',
            'screenshot_url' => 'http://www.huel.com/voluptates-saepe-reiciendis-ipsam-ducimus-nemo-molestiae-at',
            'preview_url' => 'http://www.kub.com/aspernatur-pariatur-aliquid-voluptas-dolorem-fugit-voluptatibus-aperiam',
            'homepage' => 'quis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/theme-category/2/add-theme'
payload = {
    "name": "assumenda",
    "slug": "esp-wam_k",
    "description": "Odio laudantium sed soluta perspiciatis.",
    "screenshot_url": "http:\/\/www.huel.com\/voluptates-saepe-reiciendis-ipsam-ducimus-nemo-molestiae-at",
    "preview_url": "http:\/\/www.kub.com\/aspernatur-pariatur-aliquid-voluptas-dolorem-fugit-voluptatibus-aperiam",
    "homepage": "quis"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/theme-category/{id}/add-theme

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Category ID. Example: 2

Body Parameters

name string

Example: assumenda

slug string

Must contain only letters, numbers, dashes and underscores. Example: esp-wam_k

description string

Example: Odio laudantium sed soluta perspiciatis.

screenshot_url string optional

Example: http://www.huel.com/voluptates-saepe-reiciendis-ipsam-ducimus-nemo-molestiae-at

preview_url string optional

Example: http://www.kub.com/aspernatur-pariatur-aliquid-voluptas-dolorem-fugit-voluptatibus-aperiam

homepage string optional

Example: quis

List packages

Example request:

curl --request GET \
    --get "/api/admin/packages" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/packages"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/packages';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/packages'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create package

Example request:

curl --request POST \
    "/api/admin/package" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"omnis\",
    \"plugin_automation\": \"fugiat\",
    \"theme_automation\": \"necessitatibus\"
}"

const url = new URL(
    "/api/admin/package"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "omnis",
    "plugin_automation": "fugiat",
    "theme_automation": "necessitatibus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/package';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'omnis',
            'plugin_automation' => 'fugiat',
            'theme_automation' => 'necessitatibus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/package'
payload = {
    "name": "omnis",
    "plugin_automation": "fugiat",
    "theme_automation": "necessitatibus"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/package

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

name string

Example: omnis

plugin_automation string optional

Example: fugiat

theme_automation string optional

Example: necessitatibus

plugins object optional

themes object optional

Show package details

Example request:

curl --request GET \
    --get "/api/admin/package/9" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/package/9"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/package/9';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/package/9'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update package

Example request:

curl --request PUT \
    "/api/admin/package/20" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"exercitationem\",
    \"plugin_automation\": \"accusamus\",
    \"theme_automation\": \"necessitatibus\"
}"

const url = new URL(
    "/api/admin/package/20"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "exercitationem",
    "plugin_automation": "accusamus",
    "theme_automation": "necessitatibus"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/package/20';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'exercitationem',
            'plugin_automation' => 'accusamus',
            'theme_automation' => 'necessitatibus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/package/20'
payload = {
    "name": "exercitationem",
    "plugin_automation": "accusamus",
    "theme_automation": "necessitatibus"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/admin/package/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Package ID. Example: 20

Body Parameters

name string

Example: exercitationem

plugin_automation string optional

Example: accusamus

theme_automation string optional

Example: necessitatibus

plugins object optional

themes object optional

Delete package

Example request:

curl --request DELETE \
    "/api/admin/package/5" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/package/5"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/package/5';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/package/5'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Force install package

Example request:

curl --request POST \
    "/api/admin/package/12/force-install" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/package/12/force-install"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/package/12/force-install';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/package/12/force-install'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Instance Templates

List instance templates

Example request:

curl --request GET \
    --get "/api/admin/instance-templates" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/instance-templates"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instance-templates';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instance-templates'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create instance template

Example request:

curl --request POST \
    "/api/admin/instance-template" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"laborum\",
    \"instance_id\": 11
}"

const url = new URL(
    "/api/admin/instance-template"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "laborum",
    "instance_id": 11
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instance-template';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'laborum',
            'instance_id' => 11,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instance-template'
payload = {
    "name": "laborum",
    "instance_id": 11
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update instance template

Example request:

curl --request PUT \
    "/api/admin/instance-template/9" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"

const url = new URL(
    "/api/admin/instance-template/9"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instance-template/9';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'consequatur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instance-template/9'
payload = {
    "name": "consequatur"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete instance template

Example request:

curl --request DELETE \
    "/api/admin/instance-template/8" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/instance-template/8"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instance-template/8';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instance-template/8'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Change instance template status

Example request:

curl --request PATCH \
    "/api/admin/instance-template/12/status" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"enabled\": false
}"

const url = new URL(
    "/api/admin/instance-template/12/status"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "enabled": false
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instance-template/12/status';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'enabled' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instance-template/12/status'
payload = {
    "enabled": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/admin/instance-template/{id}/status

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance Template ID. Example: 12

Body Parameters

enabled boolean true false

Example: false

Pull from instance

Example request:

curl --request PUT \
    "/api/admin/instance-template/18/pull-from-instance" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"instance_id\": 1
}"

const url = new URL(
    "/api/admin/instance-template/18/pull-from-instance"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "instance_id": 1
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/instance-template/18/pull-from-instance';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'instance_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/instance-template/18/pull-from-instance'
payload = {
    "instance_id": 1
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Health Checks

Run hosting server health check

Example request:

curl --request POST \
    "/api/admin/health-checks/servers/1" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/health-checks/servers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/health-checks/servers/1';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/health-checks/servers/1'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Run hosting account health check

Example request:

curl --request POST \
    "/api/admin/health-checks/hosting-accounts/sapiente" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/health-checks/hosting-accounts/sapiente"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/health-checks/hosting-accounts/sapiente';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/health-checks/hosting-accounts/sapiente'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Run email domain health check

Example request:

curl --request POST \
    "/api/admin/health-checks/services/minima/email-domains/necessitatibus" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/health-checks/services/minima/email-domains/necessitatibus"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/health-checks/services/minima/email-domains/necessitatibus';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/health-checks/services/minima/email-domains/necessitatibus'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/health-checks/services/{id}/email-domains/{domain}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id string

The ID of the service. Example: minima

domain string

Example: necessitatibus

int string optional

id required Service ID. Example: dolor

string string optional

domain required Domain name. Example: eveniet

Run DNS zone health check

Example request:

curl --request POST \
    "/api/admin/health-checks/services/debitis/dns-zones/magni" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/health-checks/services/debitis/dns-zones/magni"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/health-checks/services/debitis/dns-zones/magni';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/health-checks/services/debitis/dns-zones/magni'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/admin/health-checks/services/{id}/dns-zones/{domain}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id string

The ID of the service. Example: debitis

domain string

Example: magni

int string optional

id required Service ID. Example: dolorum

string string optional

domain required Domain name. Example: quis

Run domain health check

Example request:

curl --request POST \
    "/api/admin/health-checks/domains/in" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/health-checks/domains/in"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/health-checks/domains/in';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/health-checks/domains/in'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Run email server health check

Example request:

curl --request POST \
    "/api/admin/health-checks/email-servers/incidunt" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/health-checks/email-servers/incidunt"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/health-checks/email-servers/incidunt';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/health-checks/email-servers/incidunt'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Run DNS server health check

Example request:

curl --request POST \
    "/api/admin/health-checks/dns-servers/ipsam" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/health-checks/dns-servers/ipsam"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/health-checks/dns-servers/ipsam';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/health-checks/dns-servers/ipsam'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Run instance health check

Example request:

curl --request POST \
    "/api/admin/health-checks/instances/dolores" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/admin/health-checks/instances/dolores"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/health-checks/instances/dolores';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/health-checks/instances/dolores'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Background Billing

Test connection

Example request:

curl --request POST \
    "/api/admin/background-billing/test-connection" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"whmcs_url\": \"blanditiis\",
    \"whmcs_api_token\": \"quidem\"
}"

const url = new URL(
    "/api/admin/background-billing/test-connection"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "whmcs_url": "blanditiis",
    "whmcs_api_token": "quidem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/admin/background-billing/test-connection';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'whmcs_url' => 'blanditiis',
            'whmcs_api_token' => 'quidem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/admin/background-billing/test-connection'
payload = {
    "whmcs_url": "blanditiis",
    "whmcs_api_token": "quidem"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

User Endpoints

Instances

List instances

Example request:

curl --request GET \
    --get "/api/instances" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"labels\": \"et\",
    \"server_account_id\": 12
}"

const url = new URL(
    "/api/instances"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "labels": "et",
    "server_account_id": 12
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'labels' => 'et',
            'server_account_id' => 12,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances'
payload = {
    "labels": "et",
    "server_account_id": 12
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create instance

Example request:

curl --request POST \
    "/api/instances/install" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"service_id\": 16,
    \"install_method\": \"quick\",
    \"install_type\": \"clone\",
    \"instance_template_id\": 12,
    \"clone_instance_id\": 8,
    \"version\": \"nam\",
    \"name\": \"velit\",
    \"protocol\": \"https:\\/\\/\",
    \"domain\": \"example.com\",
    \"dir\": \"et\",
    \"language\": \"rerum\",
    \"db_name\": \"harum\",
    \"db_prefix\": \"eos\",
    \"admin_username\": \"odio\",
    \"admin_email\": \"johnathon16@example.org\",
    \"admin_password\": \"architecto\",
    \"theme\": \"cupiditate\",
    \"user_configurable_options\": {
        \"geo_affinity\": \"consequatur\",
        \"hosting_plan\": \"quam\"
    },
    \"reseller_user_email\": \"ed.kautzer@example.com\"
}"

const url = new URL(
    "/api/instances/install"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "service_id": 16,
    "install_method": "quick",
    "install_type": "clone",
    "instance_template_id": 12,
    "clone_instance_id": 8,
    "version": "nam",
    "name": "velit",
    "protocol": "https:\/\/",
    "domain": "example.com",
    "dir": "et",
    "language": "rerum",
    "db_name": "harum",
    "db_prefix": "eos",
    "admin_username": "odio",
    "admin_email": "johnathon16@example.org",
    "admin_password": "architecto",
    "theme": "cupiditate",
    "user_configurable_options": {
        "geo_affinity": "consequatur",
        "hosting_plan": "quam"
    },
    "reseller_user_email": "ed.kautzer@example.com"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/install';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'service_id' => 16,
            'install_method' => 'quick',
            'install_type' => 'clone',
            'instance_template_id' => 12,
            'clone_instance_id' => 8,
            'version' => 'nam',
            'name' => 'velit',
            'protocol' => 'https://',
            'domain' => 'example.com',
            'dir' => 'et',
            'language' => 'rerum',
            'db_name' => 'harum',
            'db_prefix' => 'eos',
            'admin_username' => 'odio',
            'admin_email' => 'johnathon16@example.org',
            'admin_password' => 'architecto',
            'theme' => 'cupiditate',
            'user_configurable_options' => [
                'geo_affinity' => 'consequatur',
                'hosting_plan' => 'quam',
            ],
            'reseller_user_email' => 'ed.kautzer@example.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/install'
payload = {
    "service_id": 16,
    "install_method": "quick",
    "install_type": "clone",
    "instance_template_id": 12,
    "clone_instance_id": 8,
    "version": "nam",
    "name": "velit",
    "protocol": "https:\/\/",
    "domain": "example.com",
    "dir": "et",
    "language": "rerum",
    "db_name": "harum",
    "db_prefix": "eos",
    "admin_username": "odio",
    "admin_email": "johnathon16@example.org",
    "admin_password": "architecto",
    "theme": "cupiditate",
    "user_configurable_options": {
        "geo_affinity": "consequatur",
        "hosting_plan": "quam"
    },
    "reseller_user_email": "ed.kautzer@example.com"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/instances/install

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

service_id integer

Example: 16

install_method string optional

Example: quick

Must be one of:

quick
standard
super_quick

install_type string optional

Example: clone

Must be one of:

clean
template
clone

instance_template_id integer optional

The id of an existing record in the templates table. Example: 12

clone_instance_id integer optional

Example: 8

version string optional

Example: nam

name string

Example: velit

protocol string optional

Example: https://

Must be one of:

https://
http://

domain string optional

Domain name. Example: example.com

dir string optional

Example: et

language string optional

Example: rerum

db_name string optional

Example: harum

db_prefix string optional

Example: eos

admin_username string optional

Example: odio

admin_email string optional

Example: johnathon16@example.org

admin_password string optional

Example: architecto

theme string optional

Example: cupiditate

user_configurable_options object optional

geo_affinity string optional

Example: consequatur

hosting_plan string optional

Example: quam

reseller_user_email string optional

Must be a valid email address. Example: ed.kautzer@example.com

Show instance details

Example request:

curl --request GET \
    --get "/api/instances/12" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/12';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/12'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Retry create instance

Example request:

curl --request PUT \
    "/api/instances/7/retry-install" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"install_type\": \"clean\",
    \"version\": \"tempora\",
    \"instance_template_id\": 4,
    \"clone_instance_id\": 5,
    \"name\": \"eaque\",
    \"protocol\": \"https:\\/\\/\",
    \"domain\": \"example.com\",
    \"dir\": \"reiciendis\",
    \"language\": \"ut\",
    \"db_name\": \"eaque\",
    \"db_prefix\": \"aut\",
    \"admin_username\": \"ipsum\",
    \"admin_email\": \"kendra02@example.net\",
    \"admin_password\": \"similique\",
    \"theme\": \"asperiores\"
}"

const url = new URL(
    "/api/instances/7/retry-install"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "install_type": "clean",
    "version": "tempora",
    "instance_template_id": 4,
    "clone_instance_id": 5,
    "name": "eaque",
    "protocol": "https:\/\/",
    "domain": "example.com",
    "dir": "reiciendis",
    "language": "ut",
    "db_name": "eaque",
    "db_prefix": "aut",
    "admin_username": "ipsum",
    "admin_email": "kendra02@example.net",
    "admin_password": "similique",
    "theme": "asperiores"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/7/retry-install';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'install_type' => 'clean',
            'version' => 'tempora',
            'instance_template_id' => 4,
            'clone_instance_id' => 5,
            'name' => 'eaque',
            'protocol' => 'https://',
            'domain' => 'example.com',
            'dir' => 'reiciendis',
            'language' => 'ut',
            'db_name' => 'eaque',
            'db_prefix' => 'aut',
            'admin_username' => 'ipsum',
            'admin_email' => 'kendra02@example.net',
            'admin_password' => 'similique',
            'theme' => 'asperiores',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/7/retry-install'
payload = {
    "install_type": "clean",
    "version": "tempora",
    "instance_template_id": 4,
    "clone_instance_id": 5,
    "name": "eaque",
    "protocol": "https:\/\/",
    "domain": "example.com",
    "dir": "reiciendis",
    "language": "ut",
    "db_name": "eaque",
    "db_prefix": "aut",
    "admin_username": "ipsum",
    "admin_email": "kendra02@example.net",
    "admin_password": "similique",
    "theme": "asperiores"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/retry-install

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 7

Body Parameters

install_type string optional

Example: clean

Must be one of:

clean
template
clone

version string optional

Example: tempora

instance_template_id integer optional

Example: 4

clone_instance_id integer optional

Example: 5

name string

Example: eaque

protocol string optional

Example: https://

Must be one of:

https://
http://

domain string optional

Domain name. Example: example.com

dir string optional

Example: reiciendis

language string optional

Example: ut

db_name string optional

Example: eaque

db_prefix string optional

Example: aut

admin_username string optional

Example: ipsum

admin_email string optional

Example: kendra02@example.net

admin_password string optional

Example: similique

theme string optional

Example: asperiores

Get website screenshot

Example request:

curl --request GET \
    --get "/api/instances/13/screenshot" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/13/screenshot"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/13/screenshot';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/13/screenshot'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Generate preview instance link

Example request:

curl --request POST \
    "/api/instances/7/preview" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/7/preview"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/7/preview';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/7/preview'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Assign label to instance

Example request:

curl --request POST \
    "/api/instances/11/labels" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"title\": \"My Label\"
}"

const url = new URL(
    "/api/instances/11/labels"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "My Label"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/11/labels';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'title' => 'My Label',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/11/labels'
payload = {
    "title": "My Label"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Unassign label from instance

Example request:

curl --request DELETE \
    "/api/instances/19/labels" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"title\": \"My Label\"
}"

const url = new URL(
    "/api/instances/19/labels"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "My Label"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/19/labels';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'title' => 'My Label',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/19/labels'
payload = {
    "title": "My Label"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create staging instance

Example request:

curl --request POST \
    "/api/instances/18/staging" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"protocol\": \"maxime\",
    \"domain\": \"example.com\",
    \"dir\": \"jzz-ktx_d\",
    \"skip_uploads_dir\": true
}"

const url = new URL(
    "/api/instances/18/staging"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "protocol": "maxime",
    "domain": "example.com",
    "dir": "jzz-ktx_d",
    "skip_uploads_dir": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/18/staging';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'protocol' => 'maxime',
            'domain' => 'example.com',
            'dir' => 'jzz-ktx_d',
            'skip_uploads_dir' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/18/staging'
payload = {
    "protocol": "maxime",
    "domain": "example.com",
    "dir": "jzz-ktx_d",
    "skip_uploads_dir": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/instances/{id}/staging

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 18

Body Parameters

protocol string optional

Example: maxime

domain string

Domain name. Example: example.com

dir string optional

Must contain only letters, numbers, dashes and underscores. Example: jzz-ktx_d

skip_uploads_dir boolean optional true false

Example: true

Pre-check disk usage before creating staging

Example request:

curl --request GET \
    --get "/api/instances/10/staging/pre-check-disk-usage" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"domain\": \"example.com\"
}"

const url = new URL(
    "/api/instances/10/staging/pre-check-disk-usage"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "example.com"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/10/staging/pre-check-disk-usage';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'domain' => 'example.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/10/staging/pre-check-disk-usage'
payload = {
    "domain": "example.com"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Retry create staging instance

Example request:

curl --request PUT \
    "/api/instances/8/retry-staging/praesentium" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"protocol\": \"ratione\",
    \"domain\": \"example.com\",
    \"dir\": \"uoe-ywb_n\",
    \"skip_uploads_dir\": true
}"

const url = new URL(
    "/api/instances/8/retry-staging/praesentium"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "protocol": "ratione",
    "domain": "example.com",
    "dir": "uoe-ywb_n",
    "skip_uploads_dir": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/8/retry-staging/praesentium';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'protocol' => 'ratione',
            'domain' => 'example.com',
            'dir' => 'uoe-ywb_n',
            'skip_uploads_dir' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/8/retry-staging/praesentium'
payload = {
    "protocol": "ratione",
    "domain": "example.com",
    "dir": "uoe-ywb_n",
    "skip_uploads_dir": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/retry-staging/{stagingId}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 8

stagingId string

Example: praesentium

Body Parameters

protocol string optional

Example: ratione

domain string

Domain name. Example: example.com

dir string optional

Must contain only letters, numbers, dashes and underscores. Example: uoe-ywb_n

skip_uploads_dir boolean optional true false

Example: true

Push staging instance to live

Example request:

curl --request PUT \
    "/api/instances/6/push-to-live" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"overwrite_files\": false,
    \"push_db\": true
}"

const url = new URL(
    "/api/instances/6/push-to-live"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "overwrite_files": false,
    "push_db": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/6/push-to-live';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'overwrite_files' => false,
            'push_db' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/6/push-to-live'
payload = {
    "overwrite_files": false,
    "push_db": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/push-to-live

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 6

Body Parameters

overwrite_files boolean true false

Example: false

push_db boolean true false

Example: true

structural_change_tables object optional

datachange_tables object optional

Show staging changes

Example request:

curl --request GET \
    --get "/api/instances/11/push-to-live" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/11/push-to-live"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/11/push-to-live';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/11/push-to-live'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Push live instance to staging

Example request:

curl --request PUT \
    "/api/instances/19/push-to-staging" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"overwrite_files\": true,
    \"push_db\": true
}"

const url = new URL(
    "/api/instances/19/push-to-staging"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "overwrite_files": true,
    "push_db": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/19/push-to-staging';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'overwrite_files' => true,
            'push_db' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/19/push-to-staging'
payload = {
    "overwrite_files": true,
    "push_db": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/push-to-staging

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 19

Body Parameters

overwrite_files boolean true false

Example: true

push_db boolean true false

Example: true

structural_change_tables object optional

datachange_tables object optional

Show live changes

Example request:

curl --request GET \
    --get "/api/instances/12/push-to-staging" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/12/push-to-staging"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/12/push-to-staging';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/12/push-to-staging'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List instance activity logs

Example request:

curl --request GET \
    --get "/api/instances/4/logs" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/4/logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/4/logs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/4/logs'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List webserver log files

Example request:

curl --request GET \
    --get "/api/instances/5/webserver-logs" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/5/webserver-logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/5/webserver-logs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/5/webserver-logs'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show webserver log file content

Example request:

curl --request GET \
    --get "/api/instances/dolores/webserver-logs/vel" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/dolores/webserver-logs/vel"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/dolores/webserver-logs/vel';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/dolores/webserver-logs/vel'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Download webserver log file

Example request:

curl --request GET \
    --get "/api/instances/iure/webserver-logs/consectetur/download" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/iure/webserver-logs/consectetur/download"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/iure/webserver-logs/consectetur/download';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/iure/webserver-logs/consectetur/download'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show PHP log file content

Example request:

curl --request GET \
    --get "/api/instances/5/php-logs" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/5/php-logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/5/php-logs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/5/php-logs'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Download PHP log file

Example request:

curl --request GET \
    --get "/api/instances/15/php-logs/download" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/15/php-logs/download"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/15/php-logs/download';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/15/php-logs/download'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get bandwidth usage

Example request:

curl --request GET \
    --get "/api/instances/18/reporting/bandwidth/last-year" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/18/reporting/bandwidth/last-year"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/18/reporting/bandwidth/last-year';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/18/reporting/bandwidth/last-year'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get visitors statistics

Example request:

curl --request GET \
    --get "/api/instances/18/reporting/visitors/last-year" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/18/reporting/visitors/last-year"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/18/reporting/visitors/last-year';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/18/reporting/visitors/last-year'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get visitors details

Example request:

curl --request GET \
    --get "/api/instances/11/reporting/visitors-by-device-brand/last-week" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/11/reporting/visitors-by-device-brand/last-week"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/11/reporting/visitors-by-device-brand/last-week';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/11/reporting/visitors-by-device-brand/last-week'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/instances/{id}/reporting/{type}/{period}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Example: 11

type string optional

Example: visitors-by-device-brand

Must be one of:

visits-by-page
visitors-by-country
visitors-by-continent
visitors-by-region
visitors-by-referrer
visitors-by-device
visitors-by-device-brand
visitors-by-device-os
visitors-by-device-browser

period string optional

Example: last-week

Must be one of:

last-week
last-month
last-year

Delete instance

Example request:

curl --request DELETE \
    "/api/instances/13" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"remove_data\": false,
    \"remove_database\": true
}"

const url = new URL(
    "/api/instances/13"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "remove_data": false,
    "remove_database": true
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/13';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'remove_data' => false,
            'remove_database' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/13'
payload = {
    "remove_data": false,
    "remove_database": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/instances/{id}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 13

Body Parameters

remove_data boolean optional true false

Example: false

remove_database boolean optional true false

Example: true

Show installation details

Example request:

curl --request GET \
    --get "/api/instances/14/installation-details" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/14/installation-details"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/14/installation-details';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/14/installation-details'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Refresh Website Thumbnail

Example request:

curl --request POST \
    "/api/instances/16/refresh-thumbnail" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/16/refresh-thumbnail"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/16/refresh-thumbnail';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/16/refresh-thumbnail'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List labels

Example request:

curl --request GET \
    --get "/api/labels" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/labels"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/labels';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/labels'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create label

Example request:

curl --request POST \
    "/api/labels" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"title\": \"cgul\",
    \"color\": \"#E231BC\"
}"

const url = new URL(
    "/api/labels"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "cgul",
    "color": "#E231BC"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/labels';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'title' => 'cgul',
            'color' => '#E231BC',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/labels'
payload = {
    "title": "cgul",
    "color": "#E231BC"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete label

Example request:

curl --request DELETE \
    "/api/labels" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"title\": \"sntxtk\",
    \"color\": \"#aFB\"
}"

const url = new URL(
    "/api/labels"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "sntxtk",
    "color": "#aFB"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/labels';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'title' => 'sntxtk',
            'color' => '#aFB',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/labels'
payload = {
    "title": "sntxtk",
    "color": "#aFB"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Other

List available WordPress versions

Example request:

curl --request GET \
    --get "/api/instances/wordpress-versions" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/wordpress-versions"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/wordpress-versions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/wordpress-versions'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Cancel service

Example request:

curl --request PUT \
    "/api/services/11/cancel" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"reason\": \"omnis\"
}"

const url = new URL(
    "/api/services/11/cancel"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason": "omnis"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/11/cancel';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'reason' => 'omnis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/11/cancel'
payload = {
    "reason": "omnis"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/services

Example request:

curl --request GET \
    --get "/api/services" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/services"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

WordPress

Retry WordPress import

Example request:

curl --request PUT \
    "/api/instances/4/import/quick-retry" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/4/import/quick-retry"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/4/import/quick-retry';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/4/import/quick-retry'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create WordPress SSO URL

Example request:

curl --request POST \
    "/api/instances/13/sso-url" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"user\": 1
}"

const url = new URL(
    "/api/instances/13/sso-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/13/sso-url';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'user' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/13/sso-url'
payload = {
    "user": 1
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List available updates

Example request:

curl --request GET \
    --get "/api/instances/18/wordpress/updates" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/18/wordpress/updates"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/18/wordpress/updates';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/18/wordpress/updates'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update WordPress

Example request:

curl --request PUT \
    "/api/instances/18/wordpress/update" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"version\": \"6.0.0\",
    \"create_backup\": true
}"

const url = new URL(
    "/api/instances/18/wordpress/update"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "version": "6.0.0",
    "create_backup": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/18/wordpress/update';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'version' => '6.0.0',
            'create_backup' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/18/wordpress/update'
payload = {
    "version": "6.0.0",
    "create_backup": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/update

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 18

Body Parameters

version string

Example: 6.0.0

create_backup boolean optional true false

Example: true

Return auto-update status

Example request:

curl --request GET \
    --get "/api/instances/20/wordpress/auto-update" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/20/wordpress/auto-update"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/20/wordpress/auto-update';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/20/wordpress/auto-update'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Toggle auto-update

Example request:

curl --request PUT \
    "/api/instances/4/wordpress/auto-update" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"auto_update\": \"2\",
    \"auto_update_plugins\": \"1\",
    \"auto_update_themes\": \"1\"
}"

const url = new URL(
    "/api/instances/4/wordpress/auto-update"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "auto_update": "2",
    "auto_update_plugins": "1",
    "auto_update_themes": "1"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/4/wordpress/auto-update';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'auto_update' => '2',
            'auto_update_plugins' => '1',
            'auto_update_themes' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/4/wordpress/auto-update'
payload = {
    "auto_update": "2",
    "auto_update_plugins": "1",
    "auto_update_themes": "1"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/auto-update

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 4

Body Parameters

auto_update integer

Example: 2

Must be one of:

auto_update_plugins integer

Example: 1

Must be one of:

auto_update_themes integer

Example: 1

Must be one of:

List backups

Example request:

curl --request GET \
    --get "/api/instances/4/wordpress/backups" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/4/wordpress/backups"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/4/wordpress/backups';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/4/wordpress/backups'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Download Backup

Example request:

curl --request GET \
    --get "/api/instances/20/wordpress/backups/20/download" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/20/wordpress/backups/20/download"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/20/wordpress/backups/20/download';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/20/wordpress/backups/20/download'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Restore backup

Example request:

curl --request PUT \
    "/api/instances/3/wordpress/backups/4/restore" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"restoreDatabase\": false,
    \"restoreDirectory\": false,
    \"deleteExistingFiles\": true
}"

const url = new URL(
    "/api/instances/3/wordpress/backups/4/restore"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "restoreDatabase": false,
    "restoreDirectory": false,
    "deleteExistingFiles": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/3/wordpress/backups/4/restore';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'restoreDatabase' => false,
            'restoreDirectory' => false,
            'deleteExistingFiles' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/3/wordpress/backups/4/restore'
payload = {
    "restoreDatabase": false,
    "restoreDirectory": false,
    "deleteExistingFiles": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/backups/{backupId}/restore

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 3

backupId integer

Backup ID. Example: 4

Body Parameters

restoreDatabase boolean optional true false

Example: false

restoreDirectory boolean optional true false

Example: false

deleteExistingFiles boolean optional true false

Example: true

Delete backup

Example request:

curl --request DELETE \
    "/api/instances/18/wordpress/backups/20" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/18/wordpress/backups/20"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/18/wordpress/backups/20';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/18/wordpress/backups/20'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create backup

Example request:

curl --request POST \
    "/api/instances/8/wordpress/backups" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"backupDirectory\": false,
    \"backupDatabase\": false,
    \"backupNote\": \"quisquam\",
    \"retry_id\": 1,
    \"convert_from_id\": 9
}"

const url = new URL(
    "/api/instances/8/wordpress/backups"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "backupDirectory": false,
    "backupDatabase": false,
    "backupNote": "quisquam",
    "retry_id": 1,
    "convert_from_id": 9
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/8/wordpress/backups';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'backupDirectory' => false,
            'backupDatabase' => false,
            'backupNote' => 'quisquam',
            'retry_id' => 1,
            'convert_from_id' => 9,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/8/wordpress/backups'
payload = {
    "backupDirectory": false,
    "backupDatabase": false,
    "backupNote": "quisquam",
    "retry_id": 1,
    "convert_from_id": 9
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/instances/{id}/wordpress/backups

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 8

Body Parameters

backupDirectory boolean optional true false

Example: false

backupDatabase boolean optional true false

Example: false

backupNote string optional

Example: quisquam

retry_id integer optional

Example: 1

convert_from_id integer optional

Example: 9

Show automatic backup settings

Example request:

curl --request GET \
    --get "/api/instances/12/wordpress/automatic-backup" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/12/wordpress/automatic-backup"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/12/wordpress/automatic-backup';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/12/wordpress/automatic-backup'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "location": null,
        "frequency": "weekly",
        "cron_frequency": "0 0 * * 0",
        "cron_minute": "0",
        "cron_hour": "0",
        "cron_day_of_month": "*",
        "cron_day_of_week": "0",
        "rotation": null
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update automatic backup settings

Example request:

curl --request PUT \
    "/api/instances/2/wordpress/automatic-backup" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"frequency\": \"daily\",
    \"cron_hour\": 16,
    \"cron_minute\": 25,
    \"cron_day_of_month\": 8,
    \"cron_day_of_week\": 4
}"

const url = new URL(
    "/api/instances/2/wordpress/automatic-backup"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "frequency": "daily",
    "cron_hour": 16,
    "cron_minute": 25,
    "cron_day_of_month": 8,
    "cron_day_of_week": 4
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/2/wordpress/automatic-backup';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'frequency' => 'daily',
            'cron_hour' => 16,
            'cron_minute' => 25,
            'cron_day_of_month' => 8,
            'cron_day_of_week' => 4,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/2/wordpress/automatic-backup'
payload = {
    "frequency": "daily",
    "cron_hour": 16,
    "cron_minute": 25,
    "cron_day_of_month": 8,
    "cron_day_of_week": 4
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/automatic-backup

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 2

Body Parameters

frequency string

Example: daily

Must be one of:

never
daily
weekly
monthly
custom

cron_hour integer optional

Must be at least 0. Must not be greater than 23. Example: 16

cron_minute integer optional

Must be at least 0. Must not be greater than 59. Example: 25

cron_day_of_month integer optional

Must be at least 1. Must not be greater than 28. Example: 8

cron_day_of_week integer optional

Must be at least 0. Must not be greater than 6. Example: 4

Update site name

Example request:

curl --request PUT \
    "/api/instances/17/wordpress/site-name" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"ut\"
}"

const url = new URL(
    "/api/instances/17/wordpress/site-name"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ut"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/17/wordpress/site-name';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'ut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/17/wordpress/site-name'
payload = {
    "name": "ut"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Clear cache

Example request:

curl --request PUT \
    "/api/instances/3/clear-cache" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/3/clear-cache"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/3/clear-cache';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/3/clear-cache'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show maintenance mode status

Example request:

curl --request GET \
    --get "/api/instances/2/wordpress/maintenance-mode" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/2/wordpress/maintenance-mode"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/2/wordpress/maintenance-mode';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/2/wordpress/maintenance-mode'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Toggle maintenance mode

Example request:

curl --request PUT \
    "/api/instances/10/wordpress/maintenance-mode" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"status\": true
}"

const url = new URL(
    "/api/instances/10/wordpress/maintenance-mode"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/10/wordpress/maintenance-mode';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'status' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/10/wordpress/maintenance-mode'
payload = {
    "status": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/maintenance-mode

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 10

Body Parameters

status boolean true false

Example: true

Show debug mode status

Example request:

curl --request GET \
    --get "/api/instances/19/wordpress/debug-mode" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/19/wordpress/debug-mode"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/19/wordpress/debug-mode';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/19/wordpress/debug-mode'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Toggle debug mode

Example request:

curl --request PUT \
    "/api/instances/9/wordpress/debug-mode" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"status\": true
}"

const url = new URL(
    "/api/instances/9/wordpress/debug-mode"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/9/wordpress/debug-mode';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'status' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/9/wordpress/debug-mode'
payload = {
    "status": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/debug-mode

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 9

Body Parameters

status boolean true false

Example: true

Show search engine indexing status

Example request:

curl --request GET \
    --get "/api/instances/10/wordpress/search-engine-indexing" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/10/wordpress/search-engine-indexing"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/10/wordpress/search-engine-indexing';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/10/wordpress/search-engine-indexing'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update search engine indexing status

Example request:

curl --request PUT \
    "/api/instances/11/wordpress/search-engine-indexing" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"status\": false
}"

const url = new URL(
    "/api/instances/11/wordpress/search-engine-indexing"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/11/wordpress/search-engine-indexing';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'status' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/11/wordpress/search-engine-indexing'
payload = {
    "status": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/search-engine-indexing

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 11

Body Parameters

status boolean true false

Example: false

Show Edge Cache Status

Example request:

curl --request GET \
    --get "/api/instances/13/wordpress/edge-cache" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/13/wordpress/edge-cache"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/13/wordpress/edge-cache';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/13/wordpress/edge-cache'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update Edge Cache

Example request:

curl --request PUT \
    "/api/instances/1/wordpress/edge-cache" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"status\": true
}"

const url = new URL(
    "/api/instances/1/wordpress/edge-cache"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/1/wordpress/edge-cache';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'status' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/1/wordpress/edge-cache'
payload = {
    "status": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/edge-cache

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID Example: 1

Body Parameters

status boolean true false

Example: true

Purge Edge Cache

Example request:

curl --request PUT \
    "/api/instances/20/wordpress/edge-cache/purge" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/20/wordpress/edge-cache/purge"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/20/wordpress/edge-cache/purge';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/20/wordpress/edge-cache/purge'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update Defensive Mode

Example request:

curl --request PUT \
    "/api/instances/aut/wordpress/edge-cache/defensive-mode" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"status\": false,
    \"ttl\": 14
}"

const url = new URL(
    "/api/instances/aut/wordpress/edge-cache/defensive-mode"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": false,
    "ttl": 14
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/aut/wordpress/edge-cache/defensive-mode';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'status' => false,
            'ttl' => 14,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/aut/wordpress/edge-cache/defensive-mode'
payload = {
    "status": false,
    "ttl": 14
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/edge-cache/defensive-mode

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id string

The ID of the instance. Example: aut

Body Parameters

status boolean true false

Example: false

ttl integer optional

This field is required when status is true. Example: 14

List installed themes

Example request:

curl --request GET \
    --get "/api/instances/18/wordpress/themes" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/18/wordpress/themes"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/18/wordpress/themes';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/18/wordpress/themes'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get theme screenshot

Example request:

curl --request GET \
    --get "/api/instances/13/wordpress/themes/twentytwentytwo/screenshot" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/13/wordpress/themes/twentytwentytwo/screenshot"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/13/wordpress/themes/twentytwentytwo/screenshot';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/13/wordpress/themes/twentytwentytwo/screenshot'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Activate theme

Example request:

curl --request PUT \
    "/api/instances/8/wordpress/themes/twentytwentytwo/activate" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/8/wordpress/themes/twentytwentytwo/activate"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/8/wordpress/themes/twentytwentytwo/activate';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/8/wordpress/themes/twentytwentytwo/activate'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update theme

Example request:

curl --request PUT \
    "/api/instances/4/wordpress/themes/twentytwentytwo/update" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/4/wordpress/themes/twentytwentytwo/update"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/4/wordpress/themes/twentytwentytwo/update';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/4/wordpress/themes/twentytwentytwo/update'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete theme

Example request:

curl --request DELETE \
    "/api/instances/11/wordpress/themes/twentytwentytwo" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/11/wordpress/themes/twentytwentytwo"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/11/wordpress/themes/twentytwentytwo';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/11/wordpress/themes/twentytwentytwo'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Search for new themes

Example request:

curl --request GET \
    --get "/api/instances/4/wordpress/themes/new/search/harum" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/4/wordpress/themes/new/search/harum"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/4/wordpress/themes/new/search/harum';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/4/wordpress/themes/new/search/harum'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Install theme

Example request:

curl --request POST \
    "/api/instances/20/wordpress/themes/new/twentytwentytwo/install" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/20/wordpress/themes/new/twentytwentytwo/install"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/20/wordpress/themes/new/twentytwentytwo/install';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/20/wordpress/themes/new/twentytwentytwo/install'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List featured themes

Example request:

curl --request GET \
    --get "/api/instances/19/wordpress/themes/new/featured" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/19/wordpress/themes/new/featured"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/19/wordpress/themes/new/featured';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/19/wordpress/themes/new/featured'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List installed plugins

Example request:

curl --request GET \
    --get "/api/instances/3/wordpress/plugins" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/3/wordpress/plugins"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/3/wordpress/plugins';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/3/wordpress/plugins'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Activate plugin

Example request:

curl --request PUT \
    "/api/instances/10/wordpress/plugins/hello-dolly/activate" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/10/wordpress/plugins/hello-dolly/activate"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/10/wordpress/plugins/hello-dolly/activate';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/10/wordpress/plugins/hello-dolly/activate'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Deactivate plugin

Example request:

curl --request PUT \
    "/api/instances/9/wordpress/plugins/hello-dolly/deactivate" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/9/wordpress/plugins/hello-dolly/deactivate"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/9/wordpress/plugins/hello-dolly/deactivate';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/9/wordpress/plugins/hello-dolly/deactivate'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update plugin

Example request:

curl --request PUT \
    "/api/instances/17/wordpress/plugins/hello-dolly/update" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/17/wordpress/plugins/hello-dolly/update"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/17/wordpress/plugins/hello-dolly/update';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/17/wordpress/plugins/hello-dolly/update'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete plugin

Example request:

curl --request DELETE \
    "/api/instances/7/wordpress/plugins/hello-dolly" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/7/wordpress/plugins/hello-dolly"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/7/wordpress/plugins/hello-dolly';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/7/wordpress/plugins/hello-dolly'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Search for new plugins

Example request:

curl --request GET \
    --get "/api/instances/8/wordpress/plugins/new/search/hello-dolly" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/8/wordpress/plugins/new/search/hello-dolly"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/8/wordpress/plugins/new/search/hello-dolly';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/8/wordpress/plugins/new/search/hello-dolly'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Install plugin

Example request:

curl --request POST \
    "/api/instances/3/wordpress/plugins/new/hello-dolly/install" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/3/wordpress/plugins/new/hello-dolly/install"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/3/wordpress/plugins/new/hello-dolly/install';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/3/wordpress/plugins/new/hello-dolly/install'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List featured plugins

Example request:

curl --request GET \
    --get "/api/instances/17/wordpress/plugins/new/featured" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/17/wordpress/plugins/new/featured"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/17/wordpress/plugins/new/featured';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/17/wordpress/plugins/new/featured'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List config entries

Example request:

curl --request GET \
    --get "/api/instances/7/wordpress/config" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/7/wordpress/config"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/7/wordpress/config';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/7/wordpress/config'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Add config entry

Example request:

curl --request POST \
    "/api/instances/10/wordpress/config" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"velit\",
    \"value\": \"animi\",
    \"type\": \"variable\"
}"

const url = new URL(
    "/api/instances/10/wordpress/config"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "velit",
    "value": "animi",
    "type": "variable"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/10/wordpress/config';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'velit',
            'value' => 'animi',
            'type' => 'variable',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/10/wordpress/config'
payload = {
    "name": "velit",
    "value": "animi",
    "type": "variable"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/instances/{id}/wordpress/config

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 10

Body Parameters

name string

Example: velit

value string

Example: animi

type string

Example: variable

Must be one of:

constant
variable

Update config entry

Example request:

curl --request PUT \
    "/api/instances/14/wordpress/config/iure" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"value\": \"enim\",
    \"type\": \"variable\"
}"

const url = new URL(
    "/api/instances/14/wordpress/config/iure"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "value": "enim",
    "type": "variable"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/14/wordpress/config/iure';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'value' => 'enim',
            'type' => 'variable',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/14/wordpress/config/iure'
payload = {
    "value": "enim",
    "type": "variable"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/config/{name}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 14

name string

Example: iure

Body Parameters

value string

Example: enim

type string

Example: variable

Must be one of:

constant
variable

Delete config entry

Example request:

curl --request DELETE \
    "/api/instances/12/wordpress/config/dolores" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"type\": \"variable\"
}"

const url = new URL(
    "/api/instances/12/wordpress/config/dolores"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "variable"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/12/wordpress/config/dolores';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'type' => 'variable',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/12/wordpress/config/dolores'
payload = {
    "type": "variable"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/instances/{id}/wordpress/config/{name}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 12

name string

Example: dolores

Body Parameters

type string

Example: variable

Must be one of:

constant
variable

List users

Example request:

curl --request GET \
    --get "/api/instances/7/wordpress/users" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"role\": \"subscriber\"
}"

const url = new URL(
    "/api/instances/7/wordpress/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role": "subscriber"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/7/wordpress/users';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'role' => 'subscriber',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/7/wordpress/users'
payload = {
    "role": "subscriber"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/instances/{id}/wordpress/users

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 7

Body Parameters

role string optional

Example: subscriber

Must be one of:

super-admin
administrator
editor
author
contributor
subscriber

Create user

Example request:

curl --request POST \
    "/api/instances/1/wordpress/users" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"username\": \"eos\",
    \"email\": \"kristina04@example.com\",
    \"display_name\": \"tempora\",
    \"password\": \"r\'^d$@%r&{0h\",
    \"role\": \"subscriber\",
    \"send_email\": false
}"

const url = new URL(
    "/api/instances/1/wordpress/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "eos",
    "email": "kristina04@example.com",
    "display_name": "tempora",
    "password": "r'^d$@%r&{0h",
    "role": "subscriber",
    "send_email": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/1/wordpress/users';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'username' => 'eos',
            'email' => 'kristina04@example.com',
            'display_name' => 'tempora',
            'password' => 'r\'^d$@%r&{0h',
            'role' => 'subscriber',
            'send_email' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/1/wordpress/users'
payload = {
    "username": "eos",
    "email": "kristina04@example.com",
    "display_name": "tempora",
    "password": "r'^d$@%r&{0h",
    "role": "subscriber",
    "send_email": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/instances/{id}/wordpress/users

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 1

Body Parameters

username string

Example: eos

email string

Must be a valid email address. Example: kristina04@example.com

display_name string

Example: tempora

password string

Example: r'^d$@%r&{0h

role string

Example: subscriber

Must be one of:

administrator
editor
author
contributor
subscriber

send_email boolean optional true false

Example: false

Update user

Example request:

curl --request PUT \
    "/api/instances/16/wordpress/users/2" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"email\": \"wkoepp@example.org\",
    \"display_name\": \"voluptatem\",
    \"role\": \"contributor\"
}"

const url = new URL(
    "/api/instances/16/wordpress/users/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "wkoepp@example.org",
    "display_name": "voluptatem",
    "role": "contributor"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/16/wordpress/users/2';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => 'wkoepp@example.org',
            'display_name' => 'voluptatem',
            'role' => 'contributor',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/16/wordpress/users/2'
payload = {
    "email": "wkoepp@example.org",
    "display_name": "voluptatem",
    "role": "contributor"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/users/{userId}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 16

userId integer

Example: 2

Body Parameters

email string

Must be a valid email address. Example: wkoepp@example.org

display_name string

Example: voluptatem

role string

Example: contributor

Must be one of:

administrator
editor
author
contributor
subscriber

Delete user

Example request:

curl --request DELETE \
    "/api/instances/11/wordpress/users/6" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/11/wordpress/users/6"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/11/wordpress/users/6';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/11/wordpress/users/6'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Reset user password

Example request:

curl --request PUT \
    "/api/instances/11/wordpress/users/7/reset-password" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"email\": \"kailey.cummings@example.com\",
    \"display_name\": \"et\",
    \"role\": \"subscriber\"
}"

const url = new URL(
    "/api/instances/11/wordpress/users/7/reset-password"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "kailey.cummings@example.com",
    "display_name": "et",
    "role": "subscriber"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/11/wordpress/users/7/reset-password';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => 'kailey.cummings@example.com',
            'display_name' => 'et',
            'role' => 'subscriber',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/11/wordpress/users/7/reset-password'
payload = {
    "email": "kailey.cummings@example.com",
    "display_name": "et",
    "role": "subscriber"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/wordpress/users/{userId}/reset-password

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 11

userId integer

Example: 7

Body Parameters

email string

Must be a valid email address. Example: kailey.cummings@example.com

display_name string

Example: et

role string

Example: subscriber

Must be one of:

administrator
editor
author
contributor
subscriber

Show Cloudflare settings

Example request:

curl --request GET \
    --get "/api/instances/10/wordpress/cloudflare/security" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/10/wordpress/cloudflare/security"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/10/wordpress/cloudflare/security';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/10/wordpress/cloudflare/security'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update Cloudflare settings

Example request:

curl --request PATCH \
    "/api/instances/10/wordpress/cloudflare/security" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"value\": \"under_attack\"
}"

const url = new URL(
    "/api/instances/10/wordpress/cloudflare/security"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "value": "under_attack"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/10/wordpress/cloudflare/security';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'value' => 'under_attack',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/10/wordpress/cloudflare/security'
payload = {
    "value": "under_attack"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/instances/{id}/wordpress/cloudflare/security

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 10

Body Parameters

value string

Example: under_attack

Must be one of:

off
essentially_off
low
medium
high
under_attack

Show Cloudflare browser check setting

Example request:

curl --request GET \
    --get "/api/instances/14/wordpress/cloudflare/browser-check" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/14/wordpress/cloudflare/browser-check"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/14/wordpress/cloudflare/browser-check';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/14/wordpress/cloudflare/browser-check'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update Cloudflare browser check setting

Example request:

curl --request PATCH \
    "/api/instances/10/wordpress/cloudflare/browser-check" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"value\": true
}"

const url = new URL(
    "/api/instances/10/wordpress/cloudflare/browser-check"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "value": true
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/10/wordpress/cloudflare/browser-check';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'value' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/10/wordpress/cloudflare/browser-check'
payload = {
    "value": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/instances/{id}/wordpress/cloudflare/browser-check

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 10

Body Parameters

value boolean true false

Example: true

Show Cloudflare development mode setting

Example request:

curl --request GET \
    --get "/api/instances/9/wordpress/cloudflare/development-mode" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/9/wordpress/cloudflare/development-mode"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/9/wordpress/cloudflare/development-mode';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/9/wordpress/cloudflare/development-mode'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update Cloudflare development mode setting

Example request:

curl --request PATCH \
    "/api/instances/13/wordpress/cloudflare/development-mode" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"value\": true
}"

const url = new URL(
    "/api/instances/13/wordpress/cloudflare/development-mode"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "value": true
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/13/wordpress/cloudflare/development-mode';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'value' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/13/wordpress/cloudflare/development-mode'
payload = {
    "value": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/instances/{id}/wordpress/cloudflare/development-mode

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 13

Body Parameters

value boolean true false

Example: true

Purge Cloudflare cache

Example request:

curl --request POST \
    "/api/instances/6/wordpress/cloudflare/purge-cache" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/6/wordpress/cloudflare/purge-cache"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/6/wordpress/cloudflare/purge-cache';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/6/wordpress/cloudflare/purge-cache'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Download WordPress log file

Example request:

curl --request GET \
    --get "/api/instances/8/wordpress/logs/download" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/8/wordpress/logs/download"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/8/wordpress/logs/download';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/8/wordpress/logs/download'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show WordPress logs

Example request:

curl --request GET \
    --get "/api/instances/13/wordpress/logs" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/13/wordpress/logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/13/wordpress/logs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/13/wordpress/logs'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Shared access

List users with instance's shared access

Example request:

curl --request GET \
    --get "/api/instances/17/shared-access" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/17/shared-access"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/17/shared-access';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/17/shared-access'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update privileges

Example request:

curl --request PUT \
    "/api/instances/12/shared-access" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"users\": [
        {
            \"email\": \"hdickinson@example.org\",
            \"role\": \"full_access\"
        }
    ]
}"

const url = new URL(
    "/api/instances/12/shared-access"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "users": [
        {
            "email": "hdickinson@example.org",
            "role": "full_access"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/12/shared-access';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'users' => [
                [
                    'email' => 'hdickinson@example.org',
                    'role' => 'full_access',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/12/shared-access'
payload = {
    "users": [
        {
            "email": "hdickinson@example.org",
            "role": "full_access"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/shared-access

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 12

Body Parameters

users object[]

email string

Must be a valid email address. Example: hdickinson@example.org

role string

Example: full_access

Must be one of:

view_only
view_and_sso
developer
full_access
custom

Share instance access

Example request:

curl --request POST \
    "/api/instances/3/shared-access" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"emails\": [
        \"altenwerth.jamir@example.com\"
    ],
    \"role\": \"view_and_sso\",
    \"apply_to_stagings\": false
}"

const url = new URL(
    "/api/instances/3/shared-access"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "emails": [
        "altenwerth.jamir@example.com"
    ],
    "role": "view_and_sso",
    "apply_to_stagings": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/3/shared-access';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'emails' => [
                'altenwerth.jamir@example.com',
            ],
            'role' => 'view_and_sso',
            'apply_to_stagings' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/3/shared-access'
payload = {
    "emails": [
        "altenwerth.jamir@example.com"
    ],
    "role": "view_and_sso",
    "apply_to_stagings": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/instances/{id}/shared-access

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 3

Body Parameters

emails string[]

Must be a valid email address.

role string

Example: view_and_sso

Must be one of:

view_only
view_and_sso
developer
full_access
custom

apply_to_stagings boolean optional true false

Example: false

Resend invitation

Example request:

curl --request POST \
    "/api/instances/17/shared-access/resend-invite" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"email\": \"rory03@example.com\"
}"

const url = new URL(
    "/api/instances/17/shared-access/resend-invite"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "rory03@example.com"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/17/shared-access/resend-invite';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => 'rory03@example.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/17/shared-access/resend-invite'
payload = {
    "email": "rory03@example.com"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Remove access

Example request:

curl --request DELETE \
    "/api/instances/9/shared-access" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"users\": [
        {
            \"email\": \"margret08@example.net\"
        }
    ]
}"

const url = new URL(
    "/api/instances/9/shared-access"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "users": [
        {
            "email": "margret08@example.net"
        }
    ]
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/9/shared-access';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'users' => [
                [
                    'email' => 'margret08@example.net',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/9/shared-access'
payload = {
    "users": [
        {
            "email": "margret08@example.net"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/instances/{id}/shared-access

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Instance ID. Example: 9

Body Parameters

users object[]

email string

Must be a valid email address. Example: margret08@example.net

Change instance's domain

List available options for changing domain

Example request:

curl --request GET \
    --get "/api/instances/17/change-domain/options" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/instances/17/change-domain/options"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/17/change-domain/options';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/17/change-domain/options'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Change instance's domain to custom domain

Example request:

curl --request PUT \
    "/api/instances/13/change-domain/domain" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"domain\": \"my-own-domain.com\"
}"

const url = new URL(
    "/api/instances/13/change-domain/domain"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "my-own-domain.com"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/13/change-domain/domain';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'domain' => 'my-own-domain.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/13/change-domain/domain'
payload = {
    "domain": "my-own-domain.com"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Change instance's domain to subdomain

Example request:

curl --request PUT \
    "/api/instances/9/change-domain/subdomain" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"subdomain\": \"my-subdomain\",
    \"domain\": \"example.com\"
}"

const url = new URL(
    "/api/instances/9/change-domain/subdomain"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "subdomain": "my-subdomain",
    "domain": "example.com"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/instances/9/change-domain/subdomain';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'subdomain' => 'my-subdomain',
            'domain' => 'example.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/instances/9/change-domain/subdomain'
payload = {
    "subdomain": "my-subdomain",
    "domain": "example.com"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/instances/{id}/change-domain/subdomain

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Example: 9

Body Parameters

subdomain string

Example: my-subdomain

domain string

Example: example.com

Hosting

List hosting accounts

Example request:

curl --request GET \
    --get "/api/server-accounts" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show hosting account details

Example request:

curl --request GET \
    --get "/api/server-accounts/10" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/10"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/10';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/10'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get hosting account usage

Example request:

curl --request GET \
    --get "/api/server-accounts/15/usage" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/15/usage"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/15/usage';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/15/usage'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List available PHP versions

Example request:

curl --request GET \
    --get "/api/server-accounts/15/php-versions" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/15/php-versions"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/15/php-versions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/15/php-versions'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show installed SSL certificate

Example request:

curl --request GET \
    --get "/api/server-accounts/11/ssl/certificate/installed?domain=example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/11/ssl/certificate/installed"
);

const params = {
    "domain": "example.com",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/11/ssl/certificate/installed';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'domain' => 'example.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/11/ssl/certificate/installed'
params = {
  'domain': 'example.com',
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/server-accounts/{id}/ssl/certificate/installed

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 11

Query Parameters

domain string

Domain name. Example: example.com

List SSL certificates

Example request:

curl --request GET \
    --get "/api/server-accounts/6/ssl/certificates?domain=example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"domain\": \"mollitia\"
}"

const url = new URL(
    "/api/server-accounts/6/ssl/certificates"
);

const params = {
    "domain": "example.com",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "mollitia"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/6/ssl/certificates';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'domain' => 'example.com',
        ],
        'json' => [
            'domain' => 'mollitia',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/6/ssl/certificates'
payload = {
    "domain": "mollitia"
}
params = {
  'domain': 'example.com',
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload, params=params)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/server-accounts/{id}/ssl/certificates

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 6

Query Parameters

domain string optional

Domain name. Example: example.com

Body Parameters

domain string optional

Example: mollitia

Install SSL certtficate

Example request:

curl --request PUT \
    "/api/server-accounts/8/ssl/certificates/install" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"domain\": \"est\",
    \"certificate_id\": \"molestiae\",
    \"certificate\": \"maxime\",
    \"key\": \"veritatis\",
    \"cabundle\": \"voluptatem\"
}"

const url = new URL(
    "/api/server-accounts/8/ssl/certificates/install"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "est",
    "certificate_id": "molestiae",
    "certificate": "maxime",
    "key": "veritatis",
    "cabundle": "voluptatem"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/8/ssl/certificates/install';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'domain' => 'est',
            'certificate_id' => 'molestiae',
            'certificate' => 'maxime',
            'key' => 'veritatis',
            'cabundle' => 'voluptatem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/8/ssl/certificates/install'
payload = {
    "domain": "est",
    "certificate_id": "molestiae",
    "certificate": "maxime",
    "key": "veritatis",
    "cabundle": "voluptatem"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/ssl/certificates/install

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 8

Body Parameters

domain string

Example: est

certificate_id string optional

Example: molestiae

certificate string optional

Example: maxime

key string optional

Example: veritatis

cabundle string optional

Example: voluptatem

Order SSL certificate

Example request:

curl --request POST \
    "/api/server-accounts/16/ssl/certificates/order" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"domain\": \"ipsum\",
    \"provider_id\": 5
}"

const url = new URL(
    "/api/server-accounts/16/ssl/certificates/order"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "ipsum",
    "provider_id": 5
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/16/ssl/certificates/order';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'domain' => 'ipsum',
            'provider_id' => 5,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/16/ssl/certificates/order'
payload = {
    "domain": "ipsum",
    "provider_id": 5
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/server-accounts/{id}/ssl/certificates/order

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 16

Body Parameters

domain string

Example: ipsum

provider_id integer

Example: 5

Retry SSL Certificate Provisioning

Example request:

curl --request POST \
    "/api/server-accounts/15/ssl/certificates/retry" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"domain\": \"provident\"
}"

const url = new URL(
    "/api/server-accounts/15/ssl/certificates/retry"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "provident"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/15/ssl/certificates/retry';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'domain' => 'provident',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/15/ssl/certificates/retry'
payload = {
    "domain": "provident"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show domain SSL settings

Example request:

curl --request GET \
    --get "/api/server-accounts/6/ssl/settings/example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/6/ssl/settings/example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/6/ssl/settings/example.com';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/6/ssl/settings/example.com'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update domain SSL settings

Example request:

curl --request PUT \
    "/api/server-accounts/9/ssl/settings/example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"force_https_redirect\": true
}"

const url = new URL(
    "/api/server-accounts/9/ssl/settings/example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "force_https_redirect": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/9/ssl/settings/example.com';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'force_https_redirect' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/9/ssl/settings/example.com'
payload = {
    "force_https_redirect": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/ssl/settings/{domain}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 9

domain string optional

Domain name. Example: example.com

Body Parameters

force_https_redirect boolean true false

Example: true

Create Panel SSO URL

Example request:

curl --request POST \
    "/api/server-accounts/18/control-panel-sso-url" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/18/control-panel-sso-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/18/control-panel-sso-url';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/18/control-panel-sso-url'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List domains

Example request:

curl --request GET \
    --get "/api/server-accounts/10/domains" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/10/domains"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/10/domains';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/10/domains'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Add domain

Example request:

curl --request POST \
    "/api/server-accounts/19/domains" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"domain\": \"optio\",
    \"parent_domain\": \"sit\",
    \"type\": \"alias\"
}"

const url = new URL(
    "/api/server-accounts/19/domains"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "optio",
    "parent_domain": "sit",
    "type": "alias"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/19/domains';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'domain' => 'optio',
            'parent_domain' => 'sit',
            'type' => 'alias',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/19/domains'
payload = {
    "domain": "optio",
    "parent_domain": "sit",
    "type": "alias"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/server-accounts/{id}/domains

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 19

Body Parameters

domain string

Example: optio

parent_domain string optional

Example: sit

type string

Example: alias

Must be one of:

addon
sub
alias

Update domain settings

Example request:

curl --request PUT \
    "/api/server-accounts/2/domains/example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"document_root\": \"sunt\",
    \"redirect_enabled\": true,
    \"redirect_url\": \"http:\\/\\/crooks.com\\/\"
}"

const url = new URL(
    "/api/server-accounts/2/domains/example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "document_root": "sunt",
    "redirect_enabled": true,
    "redirect_url": "http:\/\/crooks.com\/"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/2/domains/example.com';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'document_root' => 'sunt',
            'redirect_enabled' => true,
            'redirect_url' => 'http://crooks.com/',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/2/domains/example.com'
payload = {
    "document_root": "sunt",
    "redirect_enabled": true,
    "redirect_url": "http:\/\/crooks.com\/"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/domains/{domain}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 2

domain string optional

Domain name. Example: example.com

Body Parameters

document_root string

Example: sunt

redirect_enabled boolean optional true false

Example: true

redirect_url string optional

Example: http://crooks.com/

Delete domain

Example request:

curl --request DELETE \
    "/api/server-accounts/5/domains/example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/5/domains/example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/5/domains/example.com';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/5/domains/example.com'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get PHP version

Example request:

curl --request GET \
    --get "/api/server-accounts/11/domains/example.com/php-version" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/11/domains/example.com/php-version"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/11/domains/example.com/php-version';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/11/domains/example.com/php-version'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Set PHP version

Example request:

curl --request PUT \
    "/api/server-accounts/11/domains/example.com/php-version" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"php_version\": \"8.1\"
}"

const url = new URL(
    "/api/server-accounts/11/domains/example.com/php-version"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "php_version": "8.1"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/11/domains/example.com/php-version';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'php_version' => '8.1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/11/domains/example.com/php-version'
payload = {
    "php_version": "8.1"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/domains/{domain}/php-version

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 11

domain string optional

Domain name. Example: example.com

Body Parameters

php_version string optional

PHP version. Example: 8.1

Set Domain As Primary Domain

Example request:

curl --request PUT \
    "/api/server-accounts/5/domains/example.com/set-as-primary" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/5/domains/example.com/set-as-primary"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/5/domains/example.com/set-as-primary';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/5/domains/example.com/set-as-primary'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List PHP settings

Example request:

curl --request GET \
    --get "/api/server-accounts/9/domains/example.com/php-settings" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/9/domains/example.com/php-settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/9/domains/example.com/php-settings';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/9/domains/example.com/php-settings'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update PHP settings

Example request:

curl --request PUT \
    "/api/server-accounts/13/domains/example.com/php-settings" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/13/domains/example.com/php-settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/13/domains/example.com/php-settings';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/13/domains/example.com/php-settings'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List FTP accounts

Example request:

curl --request GET \
    --get "/api/server-accounts/8/ftp-accounts" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/8/ftp-accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/8/ftp-accounts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/8/ftp-accounts'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create FTP account

Example request:

curl --request POST \
    "/api/server-accounts/4/ftp-accounts" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"user\": \"aut\",
    \"domain\": \"sed\",
    \"password\": \"E-Q;D&mH-NVK\",
    \"directory\": \"fugit\",
    \"quota\": 19
}"

const url = new URL(
    "/api/server-accounts/4/ftp-accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user": "aut",
    "domain": "sed",
    "password": "E-Q;D&mH-NVK",
    "directory": "fugit",
    "quota": 19
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/4/ftp-accounts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'user' => 'aut',
            'domain' => 'sed',
            'password' => 'E-Q;D&mH-NVK',
            'directory' => 'fugit',
            'quota' => 19,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/4/ftp-accounts'
payload = {
    "user": "aut",
    "domain": "sed",
    "password": "E-Q;D&mH-NVK",
    "directory": "fugit",
    "quota": 19
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/server-accounts/{id}/ftp-accounts

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 4

Body Parameters

user string

Example: aut

domain string

Example: sed

password string

Example: E-Q;D&mH-NVK

directory string optional

Example: fugit

quota integer optional

Example: 19

Delete FTP account

Example request:

curl --request DELETE \
    "/api/server-accounts/10/ftp-accounts/ftp@example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/10/ftp-accounts/ftp@example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/10/ftp-accounts/ftp@example.com';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/10/ftp-accounts/ftp@example.com'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update FTP account

Example request:

curl --request PUT \
    "/api/server-accounts/17/ftp-accounts/ftp@example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"unlimited_quota\": false,
    \"quota\": 18,
    \"password\": \"h=:4t.L\"
}"

const url = new URL(
    "/api/server-accounts/17/ftp-accounts/ftp@example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unlimited_quota": false,
    "quota": 18,
    "password": "h=:4t.L"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/17/ftp-accounts/ftp@example.com';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'unlimited_quota' => false,
            'quota' => 18,
            'password' => 'h=:4t.L',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/17/ftp-accounts/ftp@example.com'
payload = {
    "unlimited_quota": false,
    "quota": 18,
    "password": "h=:4t.L"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/ftp-accounts/{user}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 17

user string

FTP username. Example: ftp@example.com

Body Parameters

unlimited_quota boolean optional true false

Example: false

quota integer optional

This field is required when unlimited_quota is true. Example: 18

password string optional

Example: h=:4t.L

quote string optional

Show FTP server details

Example request:

curl --request GET \
    --get "/api/server-accounts/15/ftp-accounts/server-info" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/15/ftp-accounts/server-info"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/15/ftp-accounts/server-info';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/15/ftp-accounts/server-info'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List SFTP accounts

Example request:

curl --request GET \
    --get "/api/server-accounts/14/sftp-accounts" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/14/sftp-accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/14/sftp-accounts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/14/sftp-accounts'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create SFTP account

Example request:

curl --request POST \
    "/api/server-accounts/12/sftp-accounts" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"username\": \"deserunt\",
    \"password\": \"*1^tV1UM6fMW\",
    \"public_key\": \"sed\"
}"

const url = new URL(
    "/api/server-accounts/12/sftp-accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "deserunt",
    "password": "*1^tV1UM6fMW",
    "public_key": "sed"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/12/sftp-accounts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'username' => 'deserunt',
            'password' => '*1^tV1UM6fMW',
            'public_key' => 'sed',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/12/sftp-accounts'
payload = {
    "username": "deserunt",
    "password": "*1^tV1UM6fMW",
    "public_key": "sed"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/server-accounts/{id}/sftp-accounts

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 12

Body Parameters

username string

Example: deserunt

password string optional

Example: *1^tV1UM6fMW

public_key string optional

Example: sed

Update SFTP account

Example request:

curl --request PUT \
    "/api/server-accounts/3/sftp-accounts/ftp@example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"username\": \"maxime\",
    \"password\": \"oqW2hSK#b5^kY[\\\\M\",
    \"public_key\": \"et\"
}"

const url = new URL(
    "/api/server-accounts/3/sftp-accounts/ftp@example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "maxime",
    "password": "oqW2hSK#b5^kY[\\M",
    "public_key": "et"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/3/sftp-accounts/ftp@example.com';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'username' => 'maxime',
            'password' => 'oqW2hSK#b5^kY[\\M',
            'public_key' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/3/sftp-accounts/ftp@example.com'
payload = {
    "username": "maxime",
    "password": "oqW2hSK#b5^kY[\\M",
    "public_key": "et"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/sftp-accounts/{user}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 3

user string

SFTP username. Example: ftp@example.com

Body Parameters

username string

Example: maxime

password string optional

Example: oqW2hSK#b5^kY[\M

public_key string optional

Example: et

Delete SFTP account

Example request:

curl --request DELETE \
    "/api/server-accounts/15/sftp-accounts/sftp@example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/15/sftp-accounts/sftp@example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/15/sftp-accounts/sftp@example.com';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/15/sftp-accounts/sftp@example.com'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show SFTP server details

Example request:

curl --request GET \
    --get "/api/server-accounts/20/sftp-accounts/server-info" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/20/sftp-accounts/server-info"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/20/sftp-accounts/server-info';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/20/sftp-accounts/server-info'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Disconnect All SFTP/SSH Connections

Example request:

curl --request POST \
    "/api/server-accounts/9/sftp-accounts/disconnect-all" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/9/sftp-accounts/disconnect-all"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/9/sftp-accounts/disconnect-all';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/9/sftp-accounts/disconnect-all'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Set Access Type

Example request:

curl --request POST \
    "/api/server-accounts/16/sftp-accounts/set-access-type" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"access_type\": \"sftp\"
}"

const url = new URL(
    "/api/server-accounts/16/sftp-accounts/set-access-type"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "access_type": "sftp"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/16/sftp-accounts/set-access-type';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'access_type' => 'sftp',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/16/sftp-accounts/set-access-type'
payload = {
    "access_type": "sftp"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create PHPMyAdmin SSO URL

Example request:

curl --request POST \
    "/api/server-accounts/13/mysql/phpmyadmin-sso-url" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \

const url = new URL(
    "/api/server-accounts/13/mysql/phpmyadmin-sso-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/13/mysql/phpmyadmin-sso-url';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/13/mysql/phpmyadmin-sso-url'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List MySQL databases

Example request:

curl --request GET \
    --get "/api/server-accounts/17/mysql/databases" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/17/mysql/databases"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/17/mysql/databases';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/17/mysql/databases'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create MySQL database

Example request:

curl --request POST \
    "/api/server-accounts/16/mysql/databases" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"ea\"
}"

const url = new URL(
    "/api/server-accounts/16/mysql/databases"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ea"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/16/mysql/databases';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'ea',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/16/mysql/databases'
payload = {
    "name": "ea"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Delete MySQL database

Example request:

curl --request DELETE \
    "/api/server-accounts/7/mysql/databases/user_wordpress" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/7/mysql/databases/user_wordpress"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/7/mysql/databases/user_wordpress';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/7/mysql/databases/user_wordpress'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Rename MySQL database

Example request:

curl --request PUT \
    "/api/server-accounts/13/mysql/databases/user_wordpress/name" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"debitis\"
}"

const url = new URL(
    "/api/server-accounts/13/mysql/databases/user_wordpress/name"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "debitis"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/13/mysql/databases/user_wordpress/name';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'debitis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/13/mysql/databases/user_wordpress/name'
payload = {
    "name": "debitis"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/mysql/databases/{name}/name

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 13

name string

Database name. Example: user_wordpress

Body Parameters

name string

Example: debitis

Show MySQL server details

Example request:

curl --request GET \
    --get "/api/server-accounts/18/mysql/server-info" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/18/mysql/server-info"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/18/mysql/server-info';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/18/mysql/server-info'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List MySQL users

Example request:

curl --request GET \
    --get "/api/server-accounts/16/mysql/users" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/16/mysql/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/16/mysql/users';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/16/mysql/users'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create MySQL user

Example request:

curl --request POST \
    "/api/server-accounts/6/mysql/users" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"sunt\",
    \"password\": \"Cc92ydL&aP[X7G=[P%P\",
    \"database\": \"reprehenderit\"
}"

const url = new URL(
    "/api/server-accounts/6/mysql/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "sunt",
    "password": "Cc92ydL&aP[X7G=[P%P",
    "database": "reprehenderit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/6/mysql/users';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'sunt',
            'password' => 'Cc92ydL&aP[X7G=[P%P',
            'database' => 'reprehenderit',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/6/mysql/users'
payload = {
    "name": "sunt",
    "password": "Cc92ydL&aP[X7G=[P%P",
    "database": "reprehenderit"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/server-accounts/{id}/mysql/users

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 6

Body Parameters

name string

Example: sunt

password string

Example: Cc92ydL&aP[X7G=[P%P

database string optional

Example: reprehenderit

Delete MySQL user

Example request:

curl --request DELETE \
    "/api/server-accounts/3/mysql/users/user_wordpress" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/3/mysql/users/user_wordpress"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/3/mysql/users/user_wordpress';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/3/mysql/users/user_wordpress'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update MySQL user

Example request:

curl --request PUT \
    "/api/server-accounts/18/mysql/users/user_wordpress" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"totam\",
    \"password\": \"-^5;@@3\"
}"

const url = new URL(
    "/api/server-accounts/18/mysql/users/user_wordpress"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "totam",
    "password": "-^5;@@3"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/18/mysql/users/user_wordpress';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'totam',
            'password' => '-^5;@@3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/18/mysql/users/user_wordpress'
payload = {
    "name": "totam",
    "password": "-^5;@@3"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/mysql/users/{name}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 18

name string

Database name. Example: user_wordpress

Body Parameters

name string optional

Example: totam

password string optional

Example: -^5;@@3

Show MySQL user privileges

Example request:

curl --request GET \
    --get "/api/server-accounts/19/mysql/privileges/user_wordpress/user_wordpress" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/19/mysql/privileges/user_wordpress/user_wordpress"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/19/mysql/privileges/user_wordpress/user_wordpress';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/19/mysql/privileges/user_wordpress/user_wordpress'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/server-accounts/{id}/mysql/privileges/{user}/{database}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 19

user string

Username. Example: user_wordpress

database string

Database name. Example: user_wordpress

Update MySQL user privileges

Example request:

curl --request PUT \
    "/api/server-accounts/20/mysql/privileges/user_wordpress/user_wordpress" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"privileges\": \"veniam\"
}"

const url = new URL(
    "/api/server-accounts/20/mysql/privileges/user_wordpress/user_wordpress"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "privileges": "veniam"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/20/mysql/privileges/user_wordpress/user_wordpress';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'privileges' => 'veniam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/20/mysql/privileges/user_wordpress/user_wordpress'
payload = {
    "privileges": "veniam"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/mysql/privileges/{user}/{database}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 20

user string

Username. Example: user_wordpress

database string

Database name. Example: user_wordpress

Body Parameters

privileges string

Example: veniam

Remove MySQL user privileges

Example request:

curl --request DELETE \
    "/api/server-accounts/16/mysql/privileges/user_wordpress/user_wordpress" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/16/mysql/privileges/user_wordpress/user_wordpress"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/16/mysql/privileges/user_wordpress/user_wordpress';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/16/mysql/privileges/user_wordpress/user_wordpress'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/server-accounts/{id}/mysql/privileges/{user}/{database}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 16

user string

Username. Example: user_wordpress

database string

Database name. Example: user_wordpress

List cron jobs

Example request:

curl --request GET \
    --get "/api/server-accounts/8/cron-jobs" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/8/cron-jobs"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/8/cron-jobs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/8/cron-jobs'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create cron job

Example request:

curl --request POST \
    "/api/server-accounts/14/cron-jobs" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"minute\": \"voluptatem\",
    \"hour\": \"quo\",
    \"day_of_month\": \"labore\",
    \"month\": \"ut\",
    \"day_of_week\": \"non\",
    \"command\": \"expedita\"
}"

const url = new URL(
    "/api/server-accounts/14/cron-jobs"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "minute": "voluptatem",
    "hour": "quo",
    "day_of_month": "labore",
    "month": "ut",
    "day_of_week": "non",
    "command": "expedita"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/14/cron-jobs';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'minute' => 'voluptatem',
            'hour' => 'quo',
            'day_of_month' => 'labore',
            'month' => 'ut',
            'day_of_week' => 'non',
            'command' => 'expedita',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/14/cron-jobs'
payload = {
    "minute": "voluptatem",
    "hour": "quo",
    "day_of_month": "labore",
    "month": "ut",
    "day_of_week": "non",
    "command": "expedita"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/server-accounts/{id}/cron-jobs

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 14

Body Parameters

minute string

Example: voluptatem

hour string

Example: quo

day_of_month string

Example: labore

month string

Example: ut

day_of_week string

Example: non

command string

Example: expedita

Delete cron job

Example request:

curl --request DELETE \
    "/api/server-accounts/15/cron-jobs/vitae" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/15/cron-jobs/vitae"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/15/cron-jobs/vitae';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/15/cron-jobs/vitae'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update cron job

Example request:

curl --request PUT \
    "/api/server-accounts/9/cron-jobs/temporibus" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"minute\": \"ut\",
    \"hour\": \"molestiae\",
    \"day_of_month\": \"et\",
    \"month\": \"vitae\",
    \"day_of_week\": \"expedita\",
    \"command\": \"quam\"
}"

const url = new URL(
    "/api/server-accounts/9/cron-jobs/temporibus"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "minute": "ut",
    "hour": "molestiae",
    "day_of_month": "et",
    "month": "vitae",
    "day_of_week": "expedita",
    "command": "quam"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/9/cron-jobs/temporibus';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'minute' => 'ut',
            'hour' => 'molestiae',
            'day_of_month' => 'et',
            'month' => 'vitae',
            'day_of_week' => 'expedita',
            'command' => 'quam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/9/cron-jobs/temporibus'
payload = {
    "minute": "ut",
    "hour": "molestiae",
    "day_of_month": "et",
    "month": "vitae",
    "day_of_week": "expedita",
    "command": "quam"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/cron-jobs/{line}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 9

line string

Example: temporibus

Body Parameters

minute string

Example: ut

hour string

Example: molestiae

day_of_month string

Example: et

month string

Example: vitae

day_of_week string

Example: expedita

command string

Example: quam

List DNS zones

Example request:

curl --request GET \
    --get "/api/server-accounts/16/dns-zones" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/16/dns-zones"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/16/dns-zones';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/16/dns-zones'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List DNS record types

Example request:

curl --request GET \
    --get "/api/server-accounts/5/dns-zones/record-types" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/5/dns-zones/record-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/5/dns-zones/record-types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/5/dns-zones/record-types'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List DNS zone records

Example request:

curl --request GET \
    --get "/api/server-accounts/3/dns-zones/example.com/records" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/3/dns-zones/example.com/records"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/3/dns-zones/example.com/records';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/3/dns-zones/example.com/records'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create DNS zone record

Example request:

curl --request POST \
    "/api/server-accounts/20/dns-zones/example.com/records" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"ipsam\",
    \"type\": \"a\",
    \"rdata\": \"sit\",
    \"txtdata\": \"laudantium\",
    \"target\": \"quidem\",
    \"weight\": 20,
    \"port\": 3,
    \"priority\": 8,
    \"cname\": \"et\",
    \"address\": \"velit\",
    \"flag\": false,
    \"tag\": \"quidem\",
    \"value\": \"exercitationem\",
    \"preference\": 8,
    \"exchange\": \"dignissimos\",
    \"nameserver\": \"mollitia\",
    \"pointer\": \"doloribus\",
    \"ttl\": 11,
    \"proxied\": true
}"

const url = new URL(
    "/api/server-accounts/20/dns-zones/example.com/records"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ipsam",
    "type": "a",
    "rdata": "sit",
    "txtdata": "laudantium",
    "target": "quidem",
    "weight": 20,
    "port": 3,
    "priority": 8,
    "cname": "et",
    "address": "velit",
    "flag": false,
    "tag": "quidem",
    "value": "exercitationem",
    "preference": 8,
    "exchange": "dignissimos",
    "nameserver": "mollitia",
    "pointer": "doloribus",
    "ttl": 11,
    "proxied": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/20/dns-zones/example.com/records';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'ipsam',
            'type' => 'a',
            'rdata' => 'sit',
            'txtdata' => 'laudantium',
            'target' => 'quidem',
            'weight' => 20,
            'port' => 3,
            'priority' => 8,
            'cname' => 'et',
            'address' => 'velit',
            'flag' => false,
            'tag' => 'quidem',
            'value' => 'exercitationem',
            'preference' => 8,
            'exchange' => 'dignissimos',
            'nameserver' => 'mollitia',
            'pointer' => 'doloribus',
            'ttl' => 11,
            'proxied' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/20/dns-zones/example.com/records'
payload = {
    "name": "ipsam",
    "type": "a",
    "rdata": "sit",
    "txtdata": "laudantium",
    "target": "quidem",
    "weight": 20,
    "port": 3,
    "priority": 8,
    "cname": "et",
    "address": "velit",
    "flag": false,
    "tag": "quidem",
    "value": "exercitationem",
    "preference": 8,
    "exchange": "dignissimos",
    "nameserver": "mollitia",
    "pointer": "doloribus",
    "ttl": 11,
    "proxied": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/server-accounts/{id}/dns-zones/{name}/records

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 20

name string

Zone name. Example: example.com

Body Parameters

name string

Example: ipsam

type string

Example: a

rdata string optional

Example: sit

txtdata string optional

Example: laudantium

target string optional

Example: quidem

weight integer optional

Example: 20

port integer optional

Example: 3

priority integer optional

Example: 8

cname string optional

Example: et

address string optional

Example: velit

flag boolean optional true false

Example: false

tag string optional

Example: quidem

value string optional

Example: exercitationem

preference integer optional

Example: 8

exchange string optional

Example: dignissimos

nameserver string optional

Example: mollitia

pointer string optional

Example: doloribus

ttl integer optional

Example: 11

proxied boolean optional true false

Example: true

Delete DNS zone record

Example request:

curl --request DELETE \
    "/api/server-accounts/9/dns-zones/example.com/records/eveniet" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/9/dns-zones/example.com/records/eveniet"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/9/dns-zones/example.com/records/eveniet';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/9/dns-zones/example.com/records/eveniet'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/server-accounts/{id}/dns-zones/{name}/records/{line}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 9

name string

Zone name. Example: example.com

line string

Example: eveniet

Update DNS zone record

Example request:

curl --request PUT \
    "/api/server-accounts/11/dns-zones/example.com/records/voluptatem" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"repellendus\",
    \"type\": \"id\",
    \"rdata\": \"veniam\",
    \"txtdata\": \"explicabo\",
    \"target\": \"eveniet\",
    \"weight\": 12,
    \"port\": 14,
    \"priority\": 20,
    \"cname\": \"totam\",
    \"address\": \"tempore\",
    \"flag\": false,
    \"tag\": \"magni\",
    \"value\": \"vel\",
    \"preference\": 14,
    \"exchange\": \"est\",
    \"nameserver\": \"minus\",
    \"pointer\": \"commodi\",
    \"ttl\": 7,
    \"proxied\": false
}"

const url = new URL(
    "/api/server-accounts/11/dns-zones/example.com/records/voluptatem"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "repellendus",
    "type": "id",
    "rdata": "veniam",
    "txtdata": "explicabo",
    "target": "eveniet",
    "weight": 12,
    "port": 14,
    "priority": 20,
    "cname": "totam",
    "address": "tempore",
    "flag": false,
    "tag": "magni",
    "value": "vel",
    "preference": 14,
    "exchange": "est",
    "nameserver": "minus",
    "pointer": "commodi",
    "ttl": 7,
    "proxied": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/11/dns-zones/example.com/records/voluptatem';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'repellendus',
            'type' => 'id',
            'rdata' => 'veniam',
            'txtdata' => 'explicabo',
            'target' => 'eveniet',
            'weight' => 12,
            'port' => 14,
            'priority' => 20,
            'cname' => 'totam',
            'address' => 'tempore',
            'flag' => false,
            'tag' => 'magni',
            'value' => 'vel',
            'preference' => 14,
            'exchange' => 'est',
            'nameserver' => 'minus',
            'pointer' => 'commodi',
            'ttl' => 7,
            'proxied' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/11/dns-zones/example.com/records/voluptatem'
payload = {
    "name": "repellendus",
    "type": "id",
    "rdata": "veniam",
    "txtdata": "explicabo",
    "target": "eveniet",
    "weight": 12,
    "port": 14,
    "priority": 20,
    "cname": "totam",
    "address": "tempore",
    "flag": false,
    "tag": "magni",
    "value": "vel",
    "preference": 14,
    "exchange": "est",
    "nameserver": "minus",
    "pointer": "commodi",
    "ttl": 7,
    "proxied": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/server-accounts/{id}/dns-zones/{name}/records/{line}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 11

name string

Zone name. Example: example.com

line string

Example: voluptatem

Body Parameters

name string

Example: repellendus

type string

Example: id

rdata string optional

Example: veniam

txtdata string optional

Example: explicabo

target string optional

Example: eveniet

weight integer optional

Example: 12

port integer optional

Example: 14

priority integer optional

Example: 20

cname string optional

Example: totam

address string optional

Example: tempore

flag boolean optional true false

Example: false

tag string optional

Example: magni

value string optional

Example: vel

preference integer optional

Example: 14

exchange string optional

Example: est

nameserver string optional

Example: minus

pointer string optional

Example: commodi

ttl integer optional

Example: 7

proxied boolean optional true false

Example: false

Toggle Cloudflare proxy

Example request:

curl --request PATCH \
    "/api/server-accounts/2/dns-zones/example.com/records/facilis/toggle-proxy" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/server-accounts/2/dns-zones/example.com/records/facilis/toggle-proxy"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/server-accounts/2/dns-zones/example.com/records/facilis/toggle-proxy';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/server-accounts/2/dns-zones/example.com/records/facilis/toggle-proxy'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PATCH', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/server-accounts/{id}/dns-zones/{name}/records/{line}/toggle-proxy

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 2

name string

Zone name. Example: example.com

line string

Example: facilis

List SSL offer

Example request:

curl --request GET \
    --get "/api/ssl-offer" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/ssl-offer"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/ssl-offer';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/ssl-offer'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List email domains

Example request:

curl --request GET \
    --get "/api/services/15/email/domains" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/services/15/email/domains"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/15/email/domains';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/15/email/domains'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List email accounts

Example request:

curl --request GET \
    --get "/api/services/3/email/domains/dolores/accounts" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/services/3/email/domains/dolores/accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/3/email/domains/dolores/accounts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/3/email/domains/dolores/accounts'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create email account

Example request:

curl --request POST \
    "/api/services/2/email/domains/ea/accounts" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"email\": \"dgrimes@example.net\",
    \"password\": \"EO:fW92la%KX\",
    \"domain\": \"voluptate\",
    \"quota\": 12,
    \"unlimited_quota\": true
}"

const url = new URL(
    "/api/services/2/email/domains/ea/accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "dgrimes@example.net",
    "password": "EO:fW92la%KX",
    "domain": "voluptate",
    "quota": 12,
    "unlimited_quota": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/2/email/domains/ea/accounts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => 'dgrimes@example.net',
            'password' => 'EO:fW92la%KX',
            'domain' => 'voluptate',
            'quota' => 12,
            'unlimited_quota' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/2/email/domains/ea/accounts'
payload = {
    "email": "dgrimes@example.net",
    "password": "EO:fW92la%KX",
    "domain": "voluptate",
    "quota": 12,
    "unlimited_quota": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/services/{id}/email/domains/{domainName}/accounts

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Service ID. Example: 2

domainName string

Email Domain Name. Example example.com Example: ea

Body Parameters

email string

Example: dgrimes@example.net

password string

Example: EO:fW92la%KX

domain string

Example: voluptate

quota integer

Example: 12

unlimited_quota boolean optional true false

Example: true

Delete email account

Example request:

curl --request DELETE \
    "/api/services/10/email/domains/illo/accounts/jailyn94@example.org" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/services/10/email/domains/illo/accounts/jailyn94@example.org"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/10/email/domains/illo/accounts/jailyn94@example.org';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/10/email/domains/illo/accounts/jailyn94@example.org'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/services/{id}/email/domains/{domainName}/accounts/{email}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Service ID. Example: 10

domainName string

Email Domain Name. Example example.com Example: illo

email string

Email address. Example user@example.com Example: jailyn94@example.org

Update email account

Example request:

curl --request PUT \
    "/api/services/17/email/domains/totam/accounts/jayson59@example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"quota\": 13,
    \"password\": \"gPkPPp\"
}"

const url = new URL(
    "/api/services/17/email/domains/totam/accounts/jayson59@example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "quota": 13,
    "password": "gPkPPp"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/17/email/domains/totam/accounts/jayson59@example.com';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'quota' => 13,
            'password' => 'gPkPPp',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/17/email/domains/totam/accounts/jayson59@example.com'
payload = {
    "quota": 13,
    "password": "gPkPPp"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/services/{id}/email/domains/{domainName}/accounts/{email}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 17

domainName string

Email Domain Name. Example example.com Example: totam

email string

Email address. Example user@example.com Example: jayson59@example.com

Body Parameters

quota integer

Example: 13

password string optional

Example: gPkPPp

Show email account details

Example request:

curl --request GET \
    --get "/api/services/20/email/domains/error/accounts/ondricka.ena@example.com" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/services/20/email/domains/error/accounts/ondricka.ena@example.com"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/20/email/domains/error/accounts/ondricka.ena@example.com';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/20/email/domains/error/accounts/ondricka.ena@example.com'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/services/{id}/email/domains/{domainName}/accounts/{email}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Service ID. Example: 20

domainName string

Email Domain Name. Example example.com Example: error

email string

Email address. Example user@example.com Example: ondricka.ena@example.com

Get webmail SSO URL

Example request:

curl --request GET \
    --get "/api/services/19/email/domains/et/accounts/khane@example.net/webmail-sso-url" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/services/19/email/domains/et/accounts/khane@example.net/webmail-sso-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/19/email/domains/et/accounts/khane@example.net/webmail-sso-url';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/19/email/domains/et/accounts/khane@example.net/webmail-sso-url'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/services/{id}/email/domains/{domainName}/accounts/{email}/webmail-sso-url

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 19

domainName string

Email Domain Name. Example example.com Example: et

email string

Email address. Example user@example.com Example: khane@example.net

List email forwarders

Example request:

curl --request GET \
    --get "/api/services/1/email/domains/saepe/forwarders" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/services/1/email/domains/saepe/forwarders"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/1/email/domains/saepe/forwarders';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/1/email/domains/saepe/forwarders'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create email forwarder

Example request:

curl --request POST \
    "/api/services/9/email/domains/sint/forwarders" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"email\": \"kay63@example.org\",
    \"domain\": \"minima\",
    \"destination\": \"ritchie.buddy@example.org\"
}"

const url = new URL(
    "/api/services/9/email/domains/sint/forwarders"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "kay63@example.org",
    "domain": "minima",
    "destination": "ritchie.buddy@example.org"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/9/email/domains/sint/forwarders';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => 'kay63@example.org',
            'domain' => 'minima',
            'destination' => 'ritchie.buddy@example.org',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/9/email/domains/sint/forwarders'
payload = {
    "email": "kay63@example.org",
    "domain": "minima",
    "destination": "ritchie.buddy@example.org"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/services/{id}/email/domains/{domainName}/forwarders

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Service ID. Example: 9

domainName string

Domain Name Example: sint

Body Parameters

email string

Example: kay63@example.org

domain string

Example: minima

destination string

Must be a valid email address. Example: ritchie.buddy@example.org

Delete email forwarder

Example request:

curl --request DELETE \
    "/api/services/10/email/domains/saepe/forwarders/chandler98@example.org" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/services/10/email/domains/saepe/forwarders/chandler98@example.org"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/services/10/email/domains/saepe/forwarders/chandler98@example.org';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/services/10/email/domains/saepe/forwarders/chandler98@example.org'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/services/{id}/email/domains/{domainName}/forwarders/{email}

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

URL Parameters

id integer

Hosting account ID. Example: 10

domainName string

Domain Name Example: saepe

email string

Email address. Example user@example.com Example: chandler98@example.org

User account

Update personal information

Example request:

curl --request PUT \
    "/api/user/edit" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"first_name\": \"bul\",
    \"last_name\": \"lxazolmo\",
    \"company_name\": \"tjogo\",
    \"language\": \"velit\",
    \"new_device_detection\": \"voluptate\"
}"

const url = new URL(
    "/api/user/edit"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "bul",
    "last_name": "lxazolmo",
    "company_name": "tjogo",
    "language": "velit",
    "new_device_detection": "voluptate"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/user/edit';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'first_name' => 'bul',
            'last_name' => 'lxazolmo',
            'company_name' => 'tjogo',
            'language' => 'velit',
            'new_device_detection' => 'voluptate',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/user/edit'
payload = {
    "first_name": "bul",
    "last_name": "lxazolmo",
    "company_name": "tjogo",
    "language": "velit",
    "new_device_detection": "voluptate"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/user/edit

Headers

Authorization

Example: Bearer {YOUR_API_TOKEN}

Content-Type

Example: application/json

Body Parameters

first_name string optional

Must not be greater than 255 characters. Example: bul

last_name string optional

Must not be greater than 255 characters. Example: lxazolmo

company_name string optional

Must not be greater than 255 characters. Example: tjogo

language string optional

Example: velit

new_device_detection string optional

Example: voluptate

Update email address

Example request:

curl --request PUT \
    "/api/user/edit/email" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"password\": \"0fdc0%.J#]1%`WtdY@F\",
    \"email\": \"rebecca71@example.net\"
}"

const url = new URL(
    "/api/user/edit/email"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "0fdc0%.J#]1%`WtdY@F",
    "email": "rebecca71@example.net"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/user/edit/email';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'password' => '0fdc0%.J#]1%`WtdY@F',
            'email' => 'rebecca71@example.net',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/user/edit/email'
payload = {
    "password": "0fdc0%.J#]1%`WtdY@F",
    "email": "rebecca71@example.net"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List logged-in devices

Example request:

curl --request GET \
    --get "/api/user/devices" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json"

const url = new URL(
    "/api/user/devices"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/user/devices';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/user/devices'
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Forget device

Example request:

curl --request POST \
    "/api/user/device/forget" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"deviceId\": 18
}"

const url = new URL(
    "/api/user/device/forget"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "deviceId": 18
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/user/device/forget';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'deviceId' => 18,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/user/device/forget'
payload = {
    "deviceId": 18
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Log out from device

Example request:

curl --request POST \
    "/api/user/device/logout" \
    --header "Authorization: Bearer {YOUR_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"session_id\": \"voluptatibus\"
}"

const url = new URL(
    "/api/user/device/logout"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "session_id": "voluptatibus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = '/api/user/device/logout';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'session_id' => 'voluptatibus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = '/api/user/device/logout'
payload = {
    "session_id": "voluptatibus"
}
headers = {
  'Authorization': 'Bearer {YOUR_API_TOKEN}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Introduction

Authenticating requests

Admin Endpoints

System

Show system configuration

Request

Headers

Update system configuration

Request

Headers

SSL

List SSL providers

Request

Headers

List SSL orders

Request

Headers

List SSL logs

Request

Headers

Process SSL order

Request

Headers

URL Parameters

Abandon SSL Order

Request

Headers

URL Parameters

Users

List users

Request

Headers

Body Parameters

Create user

Request

Headers

Body Parameters

List archived users

Request

Headers

Find user by email

Request

Headers

Query Parameters

Show archived user details

Request

Headers

URL Parameters

Show user details

Request

Headers

URL Parameters

Get user's last activity

Request

Headers

URL Parameters

Unarchive user

Request

Headers

URL Parameters

Update user

Request

Headers

URL Parameters

Body Parameters

Delete archived user

Request

Headers

URL Parameters

Delete user

Request

Headers

URL Parameters

Create user SSO token

Request

Headers

URL Parameters

Create admin-as-user SSO token

Request

Headers