API docs by Redocly

lima-city API (1.0.0-oas3)

Download OpenAPI specification:

E-mail: support@lima-city.de License: Apache 2.0

Manage you hosting and services from a simple and effective API.

Please see the "General API FAQ" for information on authentication. In one sentence: use "HTTP Basic Authentication" for authentication, with "api" as the username and your secret API key as the password. That's it.

dns

Manage DNS records

List domain DNS records

Authorizations:
apiKeyBasicAuth
path Parameters
domainId
required
string

Responses

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Create domain DNS record

Authorizations:
apiKeyBasicAuth
path Parameters
domainId
required
string
Request Body schema: application/json

The user to create.

required
object (NewDnsRecord)

Responses

Request samples

Content type
application/json
{
  • "nameserver_record": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update domain DNS record

Authorizations:
apiKeyBasicAuth
path Parameters
domainId
required
string
recordId
required
string
Request Body schema: application/json

The updated record

required
object (NewDnsRecord)

Responses

Request samples

Content type
application/json
{
  • "nameserver_record": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete domain DNS record

Authorizations:
apiKeyBasicAuth
path Parameters
domainId
required
string
recordId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

email

Manage hosted e-mail accounts and settings

List email addresses

Authorizations:
apiKeyBasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a mailbox

Authorizations:
apiKeyBasicAuth
Request Body schema: application/json

mailbox object

required
object (mailboxes_mailbox)

Responses

Request samples

Content type
application/json
{
  • "mailbox": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Show mailbox

Authorizations:
apiKeyBasicAuth
path Parameters
mailboxId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 123,
  • "type": "mailbox",
  • "email": "info@example.com",
  • "local_part": "info",
  • "domain": "example.com",
  • "access_denied": false,
  • "destinations": [
    ]
}

Update mailbox settings

Authorizations:
apiKeyBasicAuth
path Parameters
mailboxId
required
string
Request Body schema: application/json

The new mailbox settings

required
object (mailboxesmailboxId_mailbox)

Responses

Request samples

Content type
application/json
{
  • "mailbox": {
    }
}

Response samples

Content type
application/json
{
  • "id": 123,
  • "type": "mailbox",
  • "email": "info@example.com",
  • "local_part": "info",
  • "domain": "example.com",
  • "access_denied": false,
  • "destinations": [
    ]
}

Delete the mailbox

Authorizations:
apiKeyBasicAuth
path Parameters
mailboxId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update mailbox password

Authorizations:
apiKeyBasicAuth
path Parameters
mailboxId
required
string
Request Body schema: application/json

The new mailbox password

required
object (mailboxesmailboxIdpassword_mailbox)

Responses

Request samples

Content type
application/json
{
  • "mailbox": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Create an email alias

Authorizations:
apiKeyBasicAuth
Request Body schema: application/json

alias object

required
object (aliases_alias)

Responses

Request samples

Content type
application/json
{
  • "alias": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete the alias

Authorizations:
apiKeyBasicAuth
path Parameters
aliasId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

php

Read and manipulate PHP hosting settings

List error log entries

Authorizations:
apiKeyBasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List PHP versions

List available php versions and see the account default

Authorizations:
apiKeyBasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates the active PHP version

Authorizations:
apiKeyBasicAuth
Request Body schema: application/json

Inventory item to add

version
required
string

Responses

Request samples

Content type
application/json
{
  • "version": "5.6"
}

wordpress

WordPress management API. Show and manage WordPress installations, plugins and themes.

List WordPress sites

Authorizations:
apiKeyBasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show WordPress site

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Responses

Response samples

Content type
application/json
{
  • "wordpress": {
    },
  • "path": "mein-wordpress",
  • "link_id": "string",
  • "websites": []
}

Show WordPress updates, plugins and themes

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Responses

Response samples

Content type
application/json
{
  • "components": {
    }
}

Run WordPress plugin or theme update

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Request Body schema: application/json
required

Plugins, themes or languages to update. Only the first list will be processed, for example when plugins are given, no themes will be updated.

One of
plugins
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "plugins": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Activate WordPress plugin or theme

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Request Body schema: application/json
required

Plugins, themes or languages to activate

One of
plugins
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "themes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Deactivate WordPress plugin or theme

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Request Body schema: application/json
required

Plugins, themes or languages to deactivate

One of
plugins
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "themes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Uninstall WordPress plugin or theme

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Request Body schema: application/json
required

Plugins, themes or languages to uninstall

One of
plugins
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "themes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Run WordPress core update

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Check for WordPress updates and load the list of plugins and themes

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

wordpress-staging

WordPress staging API. Create and drop staging copies of your WordPress installation and go live if you are happy with the changes.

Show WordPress Staging Info

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Responses

Response samples

Content type
application/json
{
  • "staging": {
    }
}

Create a new wordpress staging copy

Will copy all WordPress files and database contents to a new staging directory and database. The staging copies wp-config.php will be changed.

The WordPress SIte-URL and HOME will be changed for the duration of the staging copy being a staging copy. The original value is storaged in a json file in the WordPress root folder. If the update parameter is set, updates will be run on the fresh copy.

To make the new staging hostname available via SSL, a new certificate is requested via Let's Encrypt unless a certificate already exists.

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Request Body schema: application/json
optional

staging options

object (wordpresslinkIdstart_staging_staging)

Responses

Request samples

Content type
application/json
{
  • "staging": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Go live with the staging copy

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete the staging copy (database and files)

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

wordpress-sso

WordPress Single-Sign-In API. Use this to create magic 1-Click WordPress admin login links.

Create a new single sign in session

Creates a server task to create a new single sign-in (SSO) session via a companion plugin. The plugin "WP CLI Login Command Server" will be installed if necessary.

Use the SSO session action toe the status and the link for the admin sign-in.

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

Responses

Response samples

Content type
application/json
{
  • "session_id": "e7829fdc39967a7194cacad56c7cc1b8"
}

Check SSO session readiness

Check if the SSO session has successfully been created.

Once the URL is present, you can use the follow action for a redirect to the WordPress admin-

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

sessionId
required
string

ID of the SSO session

Responses

Response samples

Content type
application/json
{
  • "session_id": "e7829fdc39967a7194cacad56c7cc1b8",
  • "url_present": true
}

Redirect to the admin sign-in link

If you have checked that the session is ready, use this link to redirect to the admin URL.

Authorizations:
apiKeyBasicAuth
path Parameters
linkId
required
string

Base64 encoded path of the wordpress installation

sessionId
required
string

ID of the SSO session

Responses

memcache

Show memcached status

Authorizations:
apiKeyBasicAuth

Responses

Response samples

Content type
application/json
{
  • "available": true,
  • "enabled": true,
  • "current_size": "128",
  • "socket": "/usr/share/lima/php-deinbenutzername/memcached.sock",
  • "stats": {
    }
}

Enable memcached

Authorizations:
apiKeyBasicAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

ssh

List ssh keys

Authorizations:
apiKeyBasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create ssh key

Authorizations:
apiKeyBasicAuth
Request Body schema: application/json

The user to create.

name
required
string
text_key
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "Mein Key",
  • "text_key": 0
}

Response samples

Content type
application/json
{
  • "id": "19567"
}