# Inleed API — full corpus

Generated from https://api.inleed.com.

---

## Base facts

- REST base URL: https://mcp.inleed.com/api/v1
- MCP endpoint: https://mcp.inleed.com/mcp
- 401 documented REST endpoints across 25 groups
- 206 MCP tools across 18 groups
- Auth: `Authorization: Bearer inl_live_…`
- All JSON is camelCase. Money is a decimal in major units with a sibling `currency`.
- Timestamps are ISO-8601 UTC with milliseconds and a trailing Z, suffixed `At`.
- `unlimited` is `null`, never the string "unlimited" and never -1. `0` and `false` are kept.

## Response envelope

A single resource is wrapperless — the object is the body. A collection is
`{ data, hasMore, nextCursor, total }`. On success the request id is in the `X-Request-Id`
response header; on failure it is in the body as `requestId`.

## Pagination

`limit` is 1–200, default 25. Over-limit returns `400 invalid_pagination_limit`.
Pass `nextCursor` back as `cursor`. **Stop when it is null.**

## Identifiers

Service, invoice and domain ids are integers that come from the client area — take them from
a listing endpoint and pass them back unchanged. Only these are prefixed ULIDs: req_ (request
id), tok_ (API token), job_ (async job), pact_ (pending action). Resources with a canonical
name use it instead ({address} for mailboxes, {tld} for a TLD, {domain} for a zone).
Never construct an id.

## Scopes

- `read:*` — Every read scope at once — the Read-only preset. Grants no write, and can never be combined with the money gate.
- `read:account` — Profile, preferences, guest access.
- `read:billing` — Invoices, PDFs, billing profiles and the prepaid balance.
- `read:services` — Subscriptions: status, renewal quotes, billing cycle.
- `read:orders` — Orders and the product catalogue.
- `read:hosting` — Inside a hosting account: usage, PHP, cron, SSL, files, logs.
- `read:dns` — DNS zones and records.
- `read:email` — Mailboxes, quotas, forwarders and delivery tracing — metadata, not message bodies.
- `read:database` — Databases, users and sizes.
- `read:files` — Directory listings, disk usage and available restore points.
- `read:domains` — Registrar-side domain state: expiry, nameservers, contacts.
- `read:support` — Tickets and replies.
- `audit:read` — The audit log. Deliberately its own grant — reading an account’s activity history is not the same thing as reading its data.
- `write:account` — Profile, preferences, guest access.
- `write:services` — Rename, autorenew, cancellation.
- `write:orders` — Creating and cancelling orders. Checkout and payment always finish in the client area.
- `write:hosting` — PHP version, SSL issuance, cron, hosting-level settings.
- `write:dns` — Create, update and delete DNS records.
- `write:email` — Mailboxes, passwords, quotas, forwarders.
- `write:database` — Databases and database users.
- `write:files` — File operations inside the hosting account — archive, move, delete.
- `write:domains` — Registrar-side changes, including nameservers.
- `write:support` — Opening a support request on the account’s behalf.
- `sso:hosting` — Single-use DirectAdmin and phpMyAdmin login links.
- `read:vps` — VPS list and detail — power state, specification, disks, templates and ISO library.
- `write:vps` — Resetting the root password. That is currently the whole grant; it is confirmation-tier.
- `power:vps` — The power switch — start, stop, reboot. Split from write:vps so a token can manage a server without the power to take it down.
- `console:vps` — Opening a VPS console session. A console is root access, so it is its own grant.
- `read:network` — Inleed network information — IP ranges and addresses, transit and peering status, licences.
- `contents:email` — Reading the contents of a mailbox — message bodies, not just the metadata read:email covers. Always required alongside read:email, and not yet selectable in the client area’s token form.
- `transfer:domains` — Starting an outbound domain transfer — the one operation that moves an asset off the account.
- `restore:hosting` — Restoring a backup over live data. Required alongside write:hosting.
- `delete:hosting` — Deleting a mailbox or another hosting resource. Required alongside the matching write scope.
- `shell:hosting` — Running shell commands on a hosting account as its own user over SSH, and enabling the assistant's SSH key for that. The customer approves the key once.
- `write:payment_methods` — Stored payment methods, and paying an invoice with one. Every charge still ends in a human confirmation link.
- `write:billing` — The money gate. Every operation that can create a charge requires it — renew, upgrade, pay, order, change billing cycle. Withhold it and nothing on the token can spend.

A tool the token has no scope for is absent from `tools/list`, not denied at call time.

## Execution tiers

- **R · Read** — Reads only. Never changes anything.
- **W · Write** — Changes something immediately. Reversible.
- **C · Confirm** — Returns a confirmation link. A human approves in the client area.
- **D · Destructive** — Cannot be undone — the description says exactly what is destroyed. Always audited.

## Idempotency

Every confirmation-tier and money operation takes `attempt_key` in the body. A repeat inside the
30-minute hold with the same key returns the existing pending action — identical but for a
freshly minted confirmationUrl, since the link is single-visit. There is no replay flag.

## Rate limits

300 requests per 5 minutes, and 60 write-tier calls per hour, per token. A 429 carries
`Retry-After` and the full `X-RateLimit-*` set. Retry-After is authoritative.

## Errors

Every non-2xx is `application/problem+json` with type, title, status, detail, code, instance,
requestId, timestamp, optional errors[] and optional recovery { action, hint, suggestedBody }.

Status codes:

- 202 — Accepted — a human must confirm before it executes
- 400 — Malformed request
- 401 — Missing or invalid token
- 402 — Payment required
- 403 — Insufficient scope, or an ownership failure
- 404 — Not found
- 405 — Method not allowed
- 409 — Conflict, or an operation already in progress
- 410 — A time-limited window has closed
- 422 — Semantic validation failure
- 429 — Rate limited
- 500 — Internal error
- 501 — Not supported on this node or account
- 502 — Upstream failure — DirectAdmin, the client area, a hosting node or a registry
- 503 — A node is temporarily unavailable
- 504 — An upstream system timed out

Codes:

- `invalid_request` (400) — The request could not be understood. Something in the request could not be parsed or violates the schema. Recovery: Read the field errors, fix the named fields, and retry.
- `invalid_pagination_limit` (400) — Pagination limit out of range. `limit` must be an integer between 1 and 200. The default is 25. Recovery: Send a limit inside the range, or omit it and take the default.
- `unauthorized` (401) — Missing or invalid API token. No `Authorization: Bearer` header was present, or the token it carried is not active. Recovery: Check the header. Tokens are minted only in the client area.
- `token_revoked` (401) — This API token has been revoked. This token was revoked in the client area. A revoked token never comes back. Recovery: Mint a new token and update the integration.
- `token_expired` (401) — This API token has expired. The token passed its expiry date. Recovery: Mint a new token; set a longer expiry if appropriate.
- `payment_required` (402) — Payment required. An unpaid invoice blocks this operation. Recovery: List unpaid invoices, then hand the account owner a payment link.
- `insufficient_scope` (403) — This token does not have the required scope. The endpoint requires a scope this token does not carry. The `detail` in the live response names it exactly — read that line rather than guessing. Scopes are fixed when a token is minted and can never be widened afterwards. Recovery: Call `whoami` (or `GET /me`) to see the scopes this token actually holds. To gain the missing one, mint a new token in the client area under Menu → API access with that scope ticked, then revoke the old one.
- `readonly_scope` (403) — This token is read-only. This token carries only read scopes; the operation writes. Recovery: Use a token with the matching write scope.
- `not_owned` (403) — Not owned by this account. The resource exists, but not under the account this token belongs to. Recovery: Take the id from the matching list endpoint for this account.
- `domain_not_owned` (403) — Domain not owned by this account. The name resolves somewhere on the platform, but not under this account. A miss for this user is a miss. Recovery: Call `GET /services` (or `list_services`) to see what this account actually owns.
- `node_not_allowed` (403) — That hosting node is not permitted. The resolved service lives on a hosting node this token may not touch. Recovery: This is a policy limit, not a transient one. Contact support if it is unexpected.
- `ip_not_allowed` (403) — This token may not be used from this IP address. This token is IP-restricted and the request came from an address outside its allowlist. Recovery: Call from an allowed address, or widen the allowlist in the client area.
- `origin_not_allowed` (403) — Requests from this origin are not accepted. The browser Origin is not on this token’s allowlist. Recovery: Add the origin in the client area, or call from a non-browser client.
- `suspended` (403) — This service is suspended. The service is suspended, usually for non-payment. Recovery: Settle the outstanding invoice; the service resumes automatically.
- `access_blocked` (403) — This request could not be completed. The request was not completed. Recovery: Contact support@inleed.se, quoting the `requestId` in the response.
- `not_found` (404) — Not found. The id is well-formed but nothing on this account matches it. Recovery: Take the id from the matching list endpoint rather than constructing it.
- `service_not_found` (404) — Service not found. No service on this account matches that id. Recovery: Call `GET /services` and use an id from the list.
- `invoice_not_found` (404) — Invoice not found. No invoice on this account matches that id. Recovery: Call `GET /invoices` and use an id from the list.
- `record_not_found` (404) — DNS record not found. No DNS record matches that id in the resolved zone. Recovery: Re-list the records; ids are derived from the record contents and change when the record changes.
- `mailbox_not_found` (404) — Mailbox not found. No mailbox matches that address on the resolved account. Recovery: Call `GET /email/accounts` to see the mailboxes that exist.
- `database_not_found` (404) — Database not found. No database matches that name on the resolved account. Recovery: Call `GET /databases` for the prefixed names.
- `job_not_found` (404) — Job not found. No async job matches that id. Recovery: Poll with the `jobId` from the handle the starting operation returned — `{jobId, kind, status, pollWith}` — never an id you constructed.
- `pending_action_not_found` (404) — Pending action not found. No pending confirmation matches that id. Recovery: It may have executed or expired. Re-list pending actions.
- `method_not_allowed` (405) — Method not allowed on this resource. This resource does not support that HTTP method. Recovery: Check the reference page for the methods this path accepts.
- `conflict` (409) — The request conflicts with the current state. The request conflicts with the current state of the resource. Recovery: Re-read the resource, then retry against its new state.
- `hosting_not_ready` (409) — The hosting account is not ready yet. The service exists but its DirectAdmin account has not finished provisioning. Recovery: Wait a few minutes and retry. This resolves on its own.
- `attempt_replayed` (409) — This attempt key has already been used. This `attempt_key` was already used inside the 30-minute idempotency window. Recovery: The original pending action is returned — identical but for a freshly minted `confirmationUrl`, since the link is single-visit. There is no replay flag: treat a `pendingActionId` you have already shown the user as the tell. Do not retry with a fresh key.
- `quota_exceeded` (409) — Quota exceeded. The operation would exceed a plan quota — disk, mailboxes, databases. Recovery: Free space or upgrade the plan, then retry.
- `confirmation_expired` (410) — The confirmation window has closed. The confirmation window (30 minutes) closed before a human approved it. Recovery: Start the operation again to mint a fresh confirmation link.
- `validation_failed` (422) — The request failed validation. Every field parsed, but the combination is not something the upstream accepts. Recovery: Read `errors[]`, which names the specific constraint that failed.
- `password_too_weak` (422) — The password does not meet the policy. The supplied password does not meet the policy. Recovery: Use a longer, higher-entropy password and retry.
- `job_not_allowed` (422) — That background job is not on the allow-list. The `kind` you asked to start is not on the allow-list of background jobs this API will run. Only a fixed set of long-running operations can be started as jobs; an arbitrary name is refused before any work begins. Recovery: Start the operation through its own endpoint rather than by naming a job kind. The `recovery.hint` in the response body names the kinds the endpoint you called will accept.
- `rate_limited` (429) — Too many requests. The token exceeded its request budget. The response carries `Retry-After`. Recovery: Wait for `Retry-After` seconds. Do not retry in a tight loop.
- `confirmation_required` (202) — A human must confirm this action. This operation costs money or cannot be undone, so it did not execute. A `confirmationUrl` is returned instead. Recovery: Hand the `confirmationUrl` to the account owner; poll the pending action for the outcome.
- `internal_error` (500) — Something went wrong on our side. An unexpected failure on our side. The stack is logged against `requestId`, never in the body. Recovery: Retry once. If it persists, quote the `requestId` to support.
- `capability_missing` (501) — This node does not support that operation. The resolved node does not support that operation (a feature it lacks). Recovery: Nothing to retry — the feature is unavailable on that node.
- `feature_not_available` (501) — That feature is not available on this account. That feature is not enabled on this account. Recovery: Contact support if you expected it to be available.
- `upstream_error` (502) — An upstream system returned an error. DirectAdmin, the client area or a registry returned something we could not use. Recovery: Retry after a short pause. Persistent failures are worth a support ticket.
- `client_area_error` (502) — The Inleed client area returned an error. The Inleed client area returned an error. Recovery: Retry after a short pause; quote the `requestId` if it persists.
- `da_error` (502) — DirectAdmin returned an error. DirectAdmin returned an error. Recovery: Retry after a short pause; quote the `requestId` if it persists.
- `node_error` (502) — The hosting node could not be reached. An operation on the hosting node itself could not be completed. A read that depends on one degrades into `notes[]` rather than failing; a write is refused and changes nothing. Recovery: Retry after a short pause; quote the `requestId` if it persists.
- `circuit_open` (503) — That node is temporarily unavailable. That node is temporarily unavailable and the circuit breaker is open. Recovery: Back off and retry in a minute or two.
- `upstream_timeout` (504) — An upstream system timed out. An upstream system did not respond in time. Recovery: Retry after a short pause. If it persists, the upstream is degraded.
- `shell_not_enabled` (409) — Shell access is not enabled for this account. Shell access has not been switched on for this hosting account, or the key that was authorised is no longer accepted. Recovery: Call `manage_shell_access` with `action=enable` for the same account. The customer approves it once, then the command can run.
- `shell_failed` (502) — The command could not be run on the hosting server. The command reached the hosting account but could not be completed there. Recovery: Retry after a short pause; quote the `requestId` if it persists.
- `command_blocked` (422) — This command is not allowed on the shell. The command is not one the shell channel will run. The refusal happens before anything reaches the server. Recovery: Read `recovery.hint` in the response body: it names what was refused. Use the tool built for that operation instead.

## Endpoint reference

### 1. Meta & discovery — 27 endpoints

Health, token identity, capabilities, and the /resolve disambiguator every other call leans on.

- **GET /api/public/v1/domains/availability** [R] scope: public
  Check one domain's availability
  params: domain*, currency, locale
  page: https://api.inleed.com/reference/meta/availability.md
- **GET /api/v1/shell/access** [R] scope: read:hosting
  Check, enable or disable shell access for the assistant
  params: input*
  page: https://api.inleed.com/reference/meta/manage-shell-access.md
- **GET /api/public/v1/products/compare** [R] scope: public
  Compare 2–4 products side by side
  params: names[]*, currency, locale
  page: https://api.inleed.com/reference/meta/compare.md
- **GET /api/v1/web/fetch** [R] scope: read:account
  Fetch a public web page
  params: url*, format
  page: https://api.inleed.com/reference/meta/get.md
- **GET /api/public/v1/broadband/addresses** [R] scope: public
  Find the addresses Inleed can deliver fiber to
  params: query*, network_id, limit
  page: https://api.inleed.com/reference/meta/list-index-2.md
- **GET /api/v1/shell/files** [R] scope: read:hosting
  Find the largest or most recently modified files
  params: input*
  page: https://api.inleed.com/reference/meta/find-files.md
- **GET /api/v1/pending-actions** [R] scope: read:account
  List held confirmation-tier actions
  params: status, limit
  page: https://api.inleed.com/reference/meta/list-pending-actions.md
- **GET /api/v1/shell/processes** [R] scope: read:hosting
  List the account's running processes
  params: input*
  page: https://api.inleed.com/reference/meta/list-processes.md
- **GET /api/public/v1/broadband/addresses/{address}/offers** [R] scope: public
  List the broadband speeds and prices available at one address
  params: address*, address_id*, customer_type
  page: https://api.inleed.com/reference/meta/offers.md
- **GET /api/v1/health** [R] scope: public
  Liveness probe
  page: https://api.inleed.com/reference/meta/get-health.md
- **GET /api/v1/whois/lookup** [R] scope: read:account
  Look up a domain in the live public WHOIS
  params: domain*
  page: https://api.inleed.com/reference/meta/list-get-2.md
- **GET /api/public/v1/products/item** [R] scope: public
  One product's full pricing and specs
  params: name*, currency, locale
  page: https://api.inleed.com/reference/meta/item.md
- **GET /api/public/v1/products/domains/{tld}** [R] scope: public
  One TLD's pricing and registry requirements
  params: tld*, tld, currency, locale
  page: https://api.inleed.com/reference/meta/tld.md
- **GET /api/public/v1/tlds/{tld}** [R] scope: public
  One TLD's pricing and registry requirements
  params: tld*, tld, currency, locale
  page: https://api.inleed.com/reference/meta/show.md
- **GET /api/v1/pending-actions/{pendingAction}** [R] scope: read:account
  Poll a held confirmation-tier action
  params: pendingAction*, id*
  page: https://api.inleed.com/reference/meta/get-pending-action.md
- **GET /api/v1/jobs/{job}** [R] scope: read:account
  Poll a long-running (async) job
  params: job*, id*
  page: https://api.inleed.com/reference/meta/list-get.md
- **GET /api/public/v1/products/domains** [R] scope: public
  Registration, renewal and transfer price per TLD
  params: tlds[], currency, locale
  page: https://api.inleed.com/reference/meta/domains.md
- **GET /api/public/v1/tlds** [R] scope: public
  Registration, renewal and transfer price per TLD
  params: tlds[], currency, locale
  page: https://api.inleed.com/reference/meta/index.md
- **GET /api/v1/resolve** [R] scope: read:services
  Resolve an identifier to its owned target
  params: input*
  page: https://api.inleed.com/reference/meta/resolve-identifier.md
- **GET /api/public/v1/domains/suggestions** [R] scope: public
  Suggest available domain names for a term
  params: term*, currency, locale
  page: https://api.inleed.com/reference/meta/suggestions.md
- **GET /api/public/v1/products** [R] scope: public
  The public product catalogue
  params: category, currency, locale
  page: https://api.inleed.com/reference/meta/list-index.md
- **GET /api/public/v1/products/{category}** [R] scope: public
  The public product catalogue
  params: category*, category, currency, locale
  page: https://api.inleed.com/reference/meta/category.md
- **GET /api/v1/capabilities** [R] scope: read:account
  What this token can do
  page: https://api.inleed.com/reference/meta/get-capabilities.md
- **POST /api/v1/shell/access** [W] scope: read:hosting
  Check, enable or disable shell access for the assistant
  params: input*, action*, attempt_key
  page: https://api.inleed.com/reference/meta/create-shell-access.md
- **POST /api/v1/shell/run** [W] scope: shell:hosting
  Run one shell command as the account user
  params: input*, attempt_key, command*, cwd, timeout
  page: https://api.inleed.com/reference/meta/run-shell-command.md
- **POST /api/v1/pending-actions/{pendingAction}/cancel** [W] scope: read:account
  Withdraw a held confirmation-tier action
  params: pendingAction*, pending_action_id*
  page: https://api.inleed.com/reference/meta/cancel-pending-action.md
- **DELETE /api/v1/shell/access** [W] scope: read:hosting
  Check, enable or disable shell access for the assistant
  params: input*
  page: https://api.inleed.com/reference/meta/delete-shell-access.md

### 2. Account & access — 21 endpoints

Profile, preferences, guest access — who the account is and who may act on it.

- **GET /api/v1/account/overview** [R] scope: read:account
  A one-call orientation for the account
  params: response_format
  page: https://api.inleed.com/reference/account/account-overview.md
- **GET /api/v1/account/accessible-accounts** [R] scope: read:account
  Accounts this user can access as a guest
  page: https://api.inleed.com/reference/account/list-accessible-accounts.md
- **GET /api/v1/account/guests** [R] scope: read:account
  Everyone with delegated access to this account
  page: https://api.inleed.com/reference/account/list-account-guests.md
- **GET /api/v1/audit-log** [R] scope: read:account
  List audit events
  params: action, tool, surface, since, until, limit
  page: https://api.inleed.com/reference/account/index.md
- **GET /api/v1/account/two-factor** [R] scope: read:account
  The 2FA state for this account
  page: https://api.inleed.com/reference/account/get-two-factor-status.md
- **GET /api/v1/account/balance/events** [R] scope: read:account
  The account's balance ledger, newest first
  params: limit
  page: https://api.inleed.com/reference/account/list-balance-events.md
- **GET /api/v1/account/onelink** [R] scope: read:account
  The account's burn-after-read OneLink handles
  page: https://api.inleed.com/reference/account/get-one-link.md
- **GET /api/v1/account/preferences** [R] scope: read:account
  The account's notification and display preferences
  page: https://api.inleed.com/reference/account/get-preferences.md
- **GET /api/v1/account/balance** [R] scope: read:billing
  The account's prepaid balance
  page: https://api.inleed.com/reference/account/get-balance.md
- **GET /api/v1/account/profile** [R] scope: read:account
  The contact profile for this account
  page: https://api.inleed.com/reference/account/get-profile.md
- **GET /api/v1/account** [R] scope: read:account
  The customer profile for this token
  page: https://api.inleed.com/reference/account/get-account.md
- **GET /api/v1/me** [R] scope: read:account
  Who this token acts as
  page: https://api.inleed.com/reference/account/get-identity.md
- **POST /api/v1/account/two-factor/enable** [W] scope: write:account
  Begin authenticator (TOTP) enrolment
  page: https://api.inleed.com/reference/account/enable-two-factor.md
- **POST /api/v1/account/two-factor/confirm** [W] scope: write:account
  Confirm authenticator enrolment with a live code
  params: code*
  page: https://api.inleed.com/reference/account/confirm-two-factor.md
- **POST /api/v1/account/balance/actions/add-funds** [W] scope: write:billing
  Hold a balance top-up for confirmation
  params: amount*, attempt_key
  page: https://api.inleed.com/reference/account/add-funds.md
- **POST /api/v1/account/profile/email-change** [W] scope: write:account
  Hold a login-email change for confirmation
  params: email*, attempt_key
  page: https://api.inleed.com/reference/account/request-email-change.md
- **POST /api/v1/account/guests** [W] scope: write:account
  Invite a guest to this account
  params: email*, role
  page: https://api.inleed.com/reference/account/add-account-guest.md
- **POST /api/v1/account/two-factor/disable** [W] scope: write:account
  Turn authenticator 2FA off
  params: code*
  page: https://api.inleed.com/reference/account/disable-two-factor.md
- **PATCH /api/v1/account/profile** [W] scope: write:account
  Change the account's contact details
  params: name, company, country, phone, locale
  page: https://api.inleed.com/reference/account/update-profile.md
- **PATCH /api/v1/account/preferences** [W] scope: write:account
  Change the account's notification and display preferences
  params: notify_news, notify_tips, notify_maintenance, show_vat
  page: https://api.inleed.com/reference/account/update-preferences.md
- **DELETE /api/v1/account/guests/{guest}** [W] scope: write:account
  Revoke a guest's access
  params: guest*, guest_id*
  page: https://api.inleed.com/reference/account/remove-account-guest.md

### 3. Billing & invoices — 24 endpoints

Invoices, PDFs, payment links, billing profiles and the prepaid balance.

- **GET /api/v1/invoices/{invoice}/pdf** [R] scope: read:billing
  Download an invoice as a PDF
  params: invoice*, invoice_id*
  page: https://api.inleed.com/reference/billing/get-invoice-pdf.md
- **GET /api/v1/billing-addresses/{billingAddress}/contacts** [R] scope: read:billing
  List a billing address's contacts
  params: billingAddress*, billing_address_id*
  page: https://api.inleed.com/reference/billing/list-billing-address-contacts.md
- **GET /api/v1/invoices** [R] scope: read:billing
  List the account's invoices
  params: status, from, to, limit, cursor
  page: https://api.inleed.com/reference/billing/list-invoices.md
- **GET /api/v1/billing-addresses/{billingAddress}** [R] scope: read:billing
  One billing address with its contacts
  params: billingAddress*, billing_address_id*
  page: https://api.inleed.com/reference/billing/get-billing-address.md
- **GET /api/v1/invoices/{invoice}** [R] scope: read:billing
  One invoice with its items and payments
  params: invoice*, invoice_id*
  page: https://api.inleed.com/reference/billing/get-invoice.md
- **GET /api/v1/billing-addresses** [R] scope: read:billing
  The account's billing profiles
  page: https://api.inleed.com/reference/billing/list-billing-addresses.md
- **GET /api/v1/billing/payment-methods** [R] scope: read:billing
  The account's saved payment methods, per billing profile
  page: https://api.inleed.com/reference/billing/list-payment-methods.md
- **GET /api/v1/billing/activity** [R] scope: read:billing
  The account's unified money timeline
  params: limit
  page: https://api.inleed.com/reference/billing/activity.md
- **GET /api/v1/invoices/{invoice}/credit-note** [R] scope: read:billing
  The credit note for an invoice
  params: invoice*, invoice_id*
  page: https://api.inleed.com/reference/billing/get-credit-note.md
- **GET /api/v1/invoices/{invoice}/payment-methods** [R] scope: read:billing
  The ways one invoice can be paid
  params: invoice*, invoice_id*
  page: https://api.inleed.com/reference/billing/get-invoice-payment-methods.md
- **POST /api/v1/invoices/{invoice}/actions/payment-link** [W] scope: write:billing
  A pay-this-invoice URL for the customer
  params: invoice*, invoice_id*
  page: https://api.inleed.com/reference/billing/create-payment-link.md
- **POST /api/v1/billing/payment-methods/cards/setup-link** [W] scope: write:billing
  A single-visit link to add a card
  params: billing_address_id
  page: https://api.inleed.com/reference/billing/get-add-card-link.md
- **POST /api/v1/billing-addresses/{billingAddress}/contacts** [W] scope: write:billing
  Add a contact to a billing address
  params: billingAddress*, billing_address_id*, type*, email*
  page: https://api.inleed.com/reference/billing/add-billing-address-contact.md
- **POST /api/v1/billing-addresses** [W] scope: write:billing
  Create a billing address
  params: name*, street*, postalcode*, city*, country*, email*, company, organization_number, vat_number, phone_number
  page: https://api.inleed.com/reference/billing/create-billing-address.md
- **POST /api/v1/invoices/{invoice}/actions/pay-with-card** [W] scope: write:billing + write:payment_methods
  Hold a card payment for confirmation
  params: invoice*, invoice_id*, card_id, attempt_key
  page: https://api.inleed.com/reference/billing/pay-invoice-with-card.md
- **POST /api/v1/invoices/{invoice}/actions/pay-with-autogiro** [W] scope: write:billing
  Hold an Autogiro payment for confirmation
  params: invoice*, invoice_id*, attempt_key
  page: https://api.inleed.com/reference/billing/pay-invoice-with-autogiro.md
- **POST /api/v1/billing-addresses/{billingAddress}/actions/set-primary** [W] scope: write:billing
  Make a billing address the default
  params: billingAddress*, billing_address_id*
  page: https://api.inleed.com/reference/billing/set-primary-billing-address.md
- **POST /api/v1/invoices/{invoice}/actions/resend-email** [W] scope: write:billing
  Re-send an invoice email
  params: invoice*, invoice_id*
  page: https://api.inleed.com/reference/billing/resend-invoice-email.md
- **POST /api/v1/invoices/{invoice}/actions/send** [W] scope: write:billing
  Send an invoice to one address
  params: invoice*, invoice_id, order_id, email*
  page: https://api.inleed.com/reference/billing/send-invoice.md
- **PATCH /api/v1/billing-addresses/{billingAddress}** [W] scope: write:billing
  Update a billing address
  params: billingAddress*, billing_address_id*, name, street, postalcode, city, email, company, organization_number, vat_number, phone_number
  page: https://api.inleed.com/reference/billing/update-billing-address.md
- **DELETE /api/v1/billing-addresses/{billingAddress}** [W] scope: write:billing
  Hold a billing-address deletion for confirmation
  params: billingAddress*, billing_address_id*, attempt_key
  page: https://api.inleed.com/reference/billing/delete-billing-address.md
- **DELETE /api/v1/billing/payment-methods/cards/{card}** [W] scope: write:billing
  Hold a saved-card removal for confirmation
  params: card*, card_id*, attempt_key
  page: https://api.inleed.com/reference/billing/remove-payment-card.md
- **DELETE /api/v1/billing-addresses/{billingAddress}/contacts/{contact}** [W] scope: write:billing
  Hold the removal of a billing-address contact for confirmation
  params: billingAddress*, contact*, billing_address_id*, contact_id*, attempt_key
  page: https://api.inleed.com/reference/billing/remove-billing-address-contact.md
- **DELETE /api/v1/invoices/{invoice}/actions/pay-with-autogiro** [W] scope: write:billing
  Unschedule a pending Autogiro payment
  params: invoice*, invoice_id*
  page: https://api.inleed.com/reference/billing/cancel-autogiro.md

### 4. Products & purchasing — 12 endpoints

The catalogue and TLD pricing an order is built from.

- **GET /api/v1/orders/{order}** [R] scope: read:orders
  Get one order
  params: order*, order_id*
  page: https://api.inleed.com/reference/products/get-order.md
- **GET /api/v1/orders** [R] scope: read:orders
  List the account's orders
  params: status, limit, cursor
  page: https://api.inleed.com/reference/products/list-orders.md
- **GET /api/v1/orders/pending** [R] scope: read:orders
  List the orders still awaiting payment
  params: limit
  page: https://api.inleed.com/reference/products/list-pending-orders.md
- **GET /api/v1/products/domains/{tld}** [R] scope: read:services
  Pricing for one TLD
  params: tld*, currency
  page: https://api.inleed.com/reference/products/get-tld-product.md
- **GET /api/v1/orders/addon-suggestions** [R] scope: read:orders
  The addons orderable with one catalogue plan
  params: service_plan_id*
  page: https://api.inleed.com/reference/products/get-addon-suggestions.md
- **GET /api/v1/products** [R] scope: read:orders
  The purchasable product catalogue
  params: category, currency
  page: https://api.inleed.com/reference/products/list-products.md
- **GET /api/v1/products/{category}** [R] scope: read:orders
  The purchasable product catalogue
  params: category*, category, currency
  page: https://api.inleed.com/reference/products/list-products-2.md
- **GET /api/v1/orders/{order}/setup** [R] scope: read:services
  Wait for a paid order's services to be set up
  params: order*, order_id*, max_wait_seconds
  page: https://api.inleed.com/reference/products/wait-for-service-setup.md
- **POST /api/v1/orders** [W] scope: write:billing + write:orders
  Hold a store order for confirmation
  params: items*, billing_address_id, attempt_key
  page: https://api.inleed.com/reference/products/create-order.md
- **POST /api/v1/orders/{order}/actions/cancel** [W] scope: write:orders
  Hold an order cancellation for confirmation
  params: order*, order_id*, attempt_key
  page: https://api.inleed.com/reference/products/cancel-order.md
- **POST /api/v1/orders/preview** [W] scope: read:orders
  Preview (price) an order without creating it
  params: items*, billing_address_id
  page: https://api.inleed.com/reference/products/preview-order.md
- **POST /api/v1/orders/validate-contact** [W] scope: read:orders
  Validate order contact details without creating anything
  params: entity_type*, name*, email*, phone_number*, country*, street*, postalcode*, city*, organization_number*, company, vat_number
  page: https://api.inleed.com/reference/products/validate-order-contact.md

### 5. Services — 18 endpoints

Every subscription: status, renewal quotes, billing cycle, autorenew, cancellation.

- **GET /api/v1/services/{service}/addons** [R] scope: read:services
  List a service's addons
  params: service*, input*
  page: https://api.inleed.com/reference/services/list-service-addons.md
- **GET /api/v1/cancellations** [R] scope: read:services
  List every scheduled cancellation on the account
  page: https://api.inleed.com/reference/services/cancellations.md
- **GET /api/v1/services** [R] scope: read:services
  List the account's services
  params: type, status, expiring_within_days, limit, cursor
  page: https://api.inleed.com/reference/services/list-services.md
- **GET /api/v1/services/{service}/actions/upgrade** [R] scope: read:services
  List upgrade / downgrade options for a service
  params: service*, input*
  page: https://api.inleed.com/reference/services/get-upgrade-options.md
- **GET /api/v1/services/{service}** [R] scope: read:services
  One service, in full
  params: service*, input*, response_format
  page: https://api.inleed.com/reference/services/get-service.md
- **GET /api/v1/services/{service}/actions/billing-cycle** [R] scope: read:services
  Preview a billing-period change
  params: service*, input*
  page: https://api.inleed.com/reference/services/get-billing-cycle-precheck.md
- **GET /api/v1/services/{service}/actions/cancel** [R] scope: read:services
  Preview a service cancellation
  params: service*, input*
  page: https://api.inleed.com/reference/services/get-cancellation-precheck.md
- **GET /api/v1/services/{service}/actions/renew** [R] scope: read:billing
  Quote a manual renewal
  params: service*, input*, years
  page: https://api.inleed.com/reference/services/get-renewal-quote.md
- **GET /api/v1/services/{service}/usage** [R] scope: read:services
  The billing usage snapshot for one service
  params: service*, input*
  page: https://api.inleed.com/reference/services/get-service-usage.md
- **GET /api/v1/services/{service}/cancellations** [R] scope: read:services
  The pending-cancellation state of one service
  params: service*, input*
  page: https://api.inleed.com/reference/services/get-service-cancellation.md
- **GET /api/v1/services/{service}/actions/pause** [R] scope: read:services
  Whether a service can be paused (it cannot)
  params: service*, input*
  page: https://api.inleed.com/reference/services/get-service-pause-status.md
- **POST /api/v1/services/{service}/actions/autorenew** [W] scope: write:services
  Enable or disable auto-renewal for a service
  params: service*, input, inputs, enabled*
  page: https://api.inleed.com/reference/services/set-autorenew.md
- **POST /api/v1/services/{service}/actions/upgrade** [W] scope: write:billing + write:services
  Hold a service upgrade for confirmation
  params: service*, input*, service_type_id, attempt_key
  page: https://api.inleed.com/reference/services/upgrade-service.md
- **POST /api/v1/services/{service}/addons** [W] scope: write:services
  Hold an addon purchase for confirmation
  params: service*, input*, service_plan_id*, quantity, attempt_key
  page: https://api.inleed.com/reference/services/add-service-addon.md
- **POST /api/v1/services/{service}/actions/rename** [W] scope: write:services
  Rename a service's display label
  params: service*, input*, name*
  page: https://api.inleed.com/reference/services/rename-service.md
- **PATCH /api/v1/services/{service}** [W] scope: write:services
  Set or clear a service's customer note
  params: service*, input*, note*
  page: https://api.inleed.com/reference/services/set-service-note.md
- **DELETE /api/v1/services/{service}/addons/{addon}** [W] scope: write:services
  Hold an addon removal for confirmation
  params: service*, addon*, input*, addon_id*, attempt_key
  page: https://api.inleed.com/reference/services/remove-service-addon.md
- **DELETE /api/v1/services/{service}/actions/upgrade** [W] scope: write:services
  Withdraw an unpaid scheduled upgrade
  params: service*, input*
  page: https://api.inleed.com/reference/services/cancel-scheduled-upgrade.md

### 6. Domains — 45 endpoints

Registrar-side domain state: expiry, nameservers, contacts.

- **GET /api/v1/snapback/eligibility** [R] scope: read:domains
  Check whether this account can book a Snapback, and what it would cost
  params: domain, billing_address_id
  page: https://api.inleed.com/reference/domains/get-snapback-eligibility.md
- **GET /api/v1/snapback/domains/{domain}** [R] scope: read:domains
  Get one dropping domain
  params: domain*, domain*
  page: https://api.inleed.com/reference/domains/get-snapback-domain.md
- **GET /api/v1/snapback/bookings/{booking}** [R] scope: read:domains
  Get one Snapback booking
  params: booking*, booking_id*
  page: https://api.inleed.com/reference/domains/get-snapback-booking.md
- **GET /api/v1/domains/{domain}/auth-code** [R] scope: transfer:domains
  Get the EPP auth code for transferring a domain out
  params: domain*, input*
  page: https://api.inleed.com/reference/domains/get-domain-auth-code.md
- **GET /api/v1/domains** [R] scope: read:domains
  List the account's registrar domains
  params: status, expiring_within_days
  page: https://api.inleed.com/reference/domains/list-domains.md
- **GET /api/v1/domains/{domain}/redirects** [R] scope: read:domains
  List the client-area web-forwards of an owned domain
  params: domain*
  page: https://api.inleed.com/reference/domains/list-domain-redirects.md
- **GET /api/v1/snapback/domains** [R] scope: read:domains
  List the domains open for a Snapback booking
  params: query, tld, expires_within_days, expires_from, expires_to, min_length, max_length, max_price_ore, featured, include_booked, sort, direction, limit, cursor
  page: https://api.inleed.com/reference/domains/list-snapback-domains.md
- **GET /api/v1/domain-transfers** [R] scope: read:domains
  List the inbound transfers on the account
  page: https://api.inleed.com/reference/domains/list-domain-transfers.md
- **GET /api/v1/domains/{domain}/contacts** [R] scope: read:domains
  List the registrar contacts of an owned domain
  params: domain*
  page: https://api.inleed.com/reference/domains/get-domain-contacts.md
- **GET /api/v1/domains/{domain}/dnssec** [R] scope: read:domains
  List the registry DNSSEC state of an owned domain
  params: domain*
  page: https://api.inleed.com/reference/domains/list-domain-dnssec.md
- **GET /api/v1/domains/{domain}/glue** [R] scope: read:domains
  List the registry glue records of an owned domain
  params: domain*
  page: https://api.inleed.com/reference/domains/list-glue-records.md
- **GET /api/v1/snapback/bookings** [R] scope: read:domains
  List this account's Snapback bookings
  params: status, limit, cursor
  page: https://api.inleed.com/reference/domains/list-snapback-bookings.md
- **GET /api/v1/domains/{domain}** [R] scope: read:domains
  One registrar domain in detail
  params: domain*, input*
  page: https://api.inleed.com/reference/domains/get-domain.md
- **GET /api/v1/domains/{domain}/actions/register** [R] scope: read:domains
  Quote a domain registration
  params: domain*, domain*, years
  page: https://api.inleed.com/reference/domains/get-register-quote.md
- **GET /api/v1/domains/{domain}/actions/renew** [R] scope: read:domains
  Quote a domain renewal
  params: domain*, input*, years
  page: https://api.inleed.com/reference/domains/get-renew-quote.md
- **GET /api/v1/domains/{domain}/actions/transfer-in** [R] scope: read:domains
  Quote a domain transfer-in
  params: domain*, domain*, years
  page: https://api.inleed.com/reference/domains/get-transfer-quote.md
- **GET /api/v1/domains/{domain}/actions/owner-change** [R] scope: write:domains
  Quote an owner change and hand off to BankID
  params: domain*, input*
  page: https://api.inleed.com/reference/domains/request-owner-change.md
- **GET /api/v1/domains/{domain}/contacts/verification** [R] scope: read:domains
  Read the ICANN verification status of an owned domain's registrant
  params: domain*
  page: https://api.inleed.com/reference/domains/get-contact-verification.md
- **GET /api/v1/domains/{domain}/whois** [R] scope: read:domains
  Read the parsed WHOIS of an owned domain
  params: domain*
  page: https://api.inleed.com/reference/domains/get-domain-whois.md
- **GET /api/v1/domains/{domain}/lifecycle** [R] scope: read:domains
  Read the registry lifecycle of an owned domain
  params: domain*
  page: https://api.inleed.com/reference/domains/get-domain-lifecycle.md
- **GET /api/v1/domain-transfers/{transfer}** [R] scope: read:domains
  Show one inbound transfer
  params: transfer*, transfer_id*
  page: https://api.inleed.com/reference/domains/get-domain-transfer.md
- **POST /api/v1/domains/{domain}/contacts/verification/resend** [W] scope: write:domains
  Attempt to resend the contact-verification e-mail
  params: domain*
  page: https://api.inleed.com/reference/domains/resend-contact-verification.md
- **POST /api/v1/domain-transfers/actions/precheck** [W] scope: write:domains
  Check whether a domain can be transferred in
  params: domain*
  page: https://api.inleed.com/reference/domains/precheck-domain-transfer.md
- **POST /api/v1/domains/{domain}/autorenew** [W] scope: write:billing
  Enable or disable auto-renewal for a domain
  params: domain*, input, inputs, enabled*
  page: https://api.inleed.com/reference/domains/set-domain-autorenew.md
- **POST /api/v1/domains/{domain}/nameservers/actions/use-inleed** [W] scope: write:domains
  Hold a "use Inleed nameservers" change for confirmation
  params: domain*, attempt_key
  page: https://api.inleed.com/reference/domains/use-inleed-nameservers.md
- **POST /api/v1/domains/{domain}/actions/register** [W] scope: write:billing + write:domains
  Hold a domain registration for confirmation
  params: domain*, domain*, years, contact, attempt_key
  page: https://api.inleed.com/reference/domains/register-domain.md
- **POST /api/v1/domains/{domain}/actions/renew** [W] scope: write:billing + write:domains
  Hold a domain renewal for confirmation
  params: domain*, input, inputs, years, attempt_key
  page: https://api.inleed.com/reference/domains/renew-domain.md
- **POST /api/v1/domains/{domain}/actions/restore** [W] scope: write:billing + write:domains
  Hold a domain restore for confirmation
  params: domain*, years, attempt_key, input*
  page: https://api.inleed.com/reference/domains/restore-domain.md
- **POST /api/v1/domains/{domain}/actions/transfer-in** [W] scope: transfer:domains + write:billing + write:domains
  Hold a domain transfer-in for confirmation
  params: domain*, domain*, auth_code*, years, attempt_key
  page: https://api.inleed.com/reference/domains/transfer-domain-in.md
- **POST /api/v1/domains/{domain}/nameservers** [W] scope: write:domains
  Hold a nameserver change for confirmation
  params: domain*, input, inputs, nameservers, attempt_key
  page: https://api.inleed.com/reference/domains/set-nameservers.md
- **POST /api/v1/snapback/bookings** [C] scope: write:billing + write:domains
  Hold a Snapback booking for human confirmation
  params: domain*, contact_id, billing_address_id, attempt_key
  page: https://api.inleed.com/reference/domains/book-snapback-domain.md
- **POST /api/v1/domain-transfers/{transfer}/actions/cancel** [W] scope: write:domains
  Hold a transfer cancellation for confirmation
  params: transfer*, transfer_id*, attempt_key
  page: https://api.inleed.com/reference/domains/cancel-domain-transfer.md
- **POST /api/v1/domain-transfers/{transfer}/actions/retry** [W] scope: write:domains
  Hold a transfer re-check for confirmation
  params: transfer*, transfer_id*, attempt_key
  page: https://api.inleed.com/reference/domains/retry-domain-transfer.md
- **POST /api/v1/domain-transfers** [W] scope: write:domains
  Initiate an inbound domain transfer
  params: domain*, auth_code*
  page: https://api.inleed.com/reference/domains/initiate-domain-transfer.md
- **POST /api/v1/domains/{domain}/dnssec** [W] scope: write:domains
  List, add or remove DNSSEC DS records
  params: domain*, input*, action*, ds_record
  page: https://api.inleed.com/reference/domains/manage-dnssec.md
- **POST /api/v1/domains/{domain}/actions/status-sync** [W] scope: write:domains
  Re-read the registry and report drift
  params: domain*
  page: https://api.inleed.com/reference/domains/sync-domain-status.md
- **POST /api/v1/domains/{domain}/redirects** [W] scope: write:domains
  Record a web-forward for an owned domain
  params: domain*, source*, target*, type
  page: https://api.inleed.com/reference/domains/create-domain-redirect.md
- **POST /api/v1/domains/{domain}/lock** [W] scope: write:domains
  Set or clear the transfer lock (not available)
  params: domain*, input*, locked
  page: https://api.inleed.com/reference/domains/set-domain-lock.md
- **POST /api/v1/domains/{domain}/registrant** [W] scope: write:domains
  Update the registrant contact
  params: domain*, input*, contact*
  page: https://api.inleed.com/reference/domains/update-registrant.md
- **PUT /api/v1/domains/{domain}/glue** [W] scope: write:domains
  Hold a glue-record write for confirmation
  params: domain*, host*, ip_addresses*, attempt_key
  page: https://api.inleed.com/reference/domains/set-glue-record.md
- **PUT /api/v1/domains/{domain}/contacts** [W] scope: write:domains
  Hold a registrar contact update for confirmation
  params: domain*, first_name*, last_name*, email*, street*, city*, postalcode*, country*, phone*, state, company, organization_no, vat_number, attempt_key
  page: https://api.inleed.com/reference/domains/update-domain-contacts.md
- **PUT /api/v1/domains/{domain}/dnssec/auto** [W] scope: write:domains
  Set DNSSEC auto-management
  params: domain*, enabled
  page: https://api.inleed.com/reference/domains/set-dnssec-auto.md
- **DELETE /api/v1/domains/{domain}/dnssec/{recordId}** [W] scope: write:domains
  Attempt to remove one DS record
  params: domain*, recordId*, record_id*
  page: https://api.inleed.com/reference/domains/delete-dnssec-record.md
- **DELETE /api/v1/domains/{domain}/glue** [W] scope: write:domains
  Hold a glue-record removal for confirmation
  params: domain*, host*, attempt_key
  page: https://api.inleed.com/reference/domains/delete-glue-record.md
- **DELETE /api/v1/domains/{domain}/redirects/{redirect}** [W] scope: write:domains
  Remove a web-forward from an owned domain
  params: domain*, redirect*, redirect*
  page: https://api.inleed.com/reference/domains/delete-domain-redirect.md

### 7. DNS zones & records — 19 endpoints

Zones and records on our nameservers, plus a derived health check.

- **GET /api/v1/dns/propagation** [R] scope: read:dns
  Check a DNS record's propagation across public resolvers
  params: name*, type, expected
  page: https://api.inleed.com/reference/dns/check-dns-propagation.md
- **GET /api/v1/dns/health** [R] scope: read:dns
  Diagnose a zone's DNS health
  params: input*
  page: https://api.inleed.com/reference/dns/check-dns-health.md
- **GET /api/v1/dns/zone/export** [R] scope: read:dns
  Export a DNS zone as a BIND file
  params: input*
  page: https://api.inleed.com/reference/dns/export-dns-zone.md
- **GET /api/v1/dns/zone/lint** [R] scope: read:dns
  Lint a DNS zone for hygiene problems
  params: input*
  page: https://api.inleed.com/reference/dns/lint-dns-zone.md
- **GET /api/v1/dns/zones** [R] scope: read:dns
  List the account's DNS zones
  page: https://api.inleed.com/reference/dns/list-dns-zones.md
- **GET /api/v1/dns/records** [R] scope: read:dns
  List the DNS records of a zone
  params: input*, type, limit
  page: https://api.inleed.com/reference/dns/list-dns-records.md
- **GET /api/v1/dns/zone/mx-templates** [R] scope: read:dns
  List the MX (mail) templates for a zone
  params: input*
  page: https://api.inleed.com/reference/dns/list-mx-templates.md
- **GET /api/v1/dns/lookup** [R] scope: read:dns
  Look up a name in the public DNS
  params: name*, type
  page: https://api.inleed.com/reference/dns/dns-lookup.md
- **GET /api/v1/dns/zone** [R] scope: read:dns
  Summarise a DNS zone
  params: input*
  page: https://api.inleed.com/reference/dns/get-dns-zone.md
- **GET /api/v1/dns/zone/snapshots** [R] scope: read:dns
  Zone snapshots (not yet available)
  params: input*
  page: https://api.inleed.com/reference/dns/dns-zone-snapshots.md
- **POST /api/v1/dns/zone/records/bulk** [W] scope: write:dns
  Apply a bulk DNS change
  params: input*, records*
  page: https://api.inleed.com/reference/dns/bulk-dns-records.md
- **POST /api/v1/dns/zone/mx-templates/apply** [W] scope: write:dns
  Apply an MX template
  params: input*, template*
  page: https://api.inleed.com/reference/dns/apply-mx-template.md
- **POST /api/v1/dns/records** [W] scope: write:dns
  Create a DNS record
  params: input*, type*, name*, value*, ttl, priority
  page: https://api.inleed.com/reference/dns/create-dns-record.md
- **POST /api/v1/dns/zone/actions/reset** [W] scope: write:dns
  Reset a DNS zone to defaults
  params: input*
  page: https://api.inleed.com/reference/dns/reset-dns-zone.md
- **POST /api/v1/dns/zone/snapshots** [W] scope: write:dns
  Zone snapshots (not yet available)
  params: input*
  page: https://api.inleed.com/reference/dns/create-dns-zone-snapshots.md
- **POST /api/v1/dns/zone/snapshots/restore** [W] scope: write:dns
  Zone snapshots (not yet available)
  params: input*
  page: https://api.inleed.com/reference/dns/create-dns-zone-snapshots-2.md
- **PUT /api/v1/dns/zone/import** [W] scope: write:dns
  Import a BIND zone file
  params: input*, zone*, mode
  page: https://api.inleed.com/reference/dns/import-dns-zone.md
- **PUT /api/v1/dns/records** [W] scope: write:dns
  Update a DNS record
  params: input*, record_id*, value, ttl, priority
  page: https://api.inleed.com/reference/dns/update-dns-record.md
- **DELETE /api/v1/dns/records** [W] scope: write:dns
  Delete a DNS record
  params: input*, record_id*
  page: https://api.inleed.com/reference/dns/delete-dns-record.md

### 8. Web hosting account — 24 endpoints

The DirectAdmin account itself: usage, PHP, resources and single-use panel logins.

- **GET /api/v1/hosting/credentials** [R] scope: read:hosting
  Get an account's non-secret connection details
  params: input*
  page: https://api.inleed.com/reference/hosting/get-hosting-credentials.md
- **GET /api/v1/hosting/usage** [R] scope: read:hosting
  Get an account's quota usage
  params: input*
  page: https://api.inleed.com/reference/hosting/get-hosting-usage.md
- **GET /api/v1/hosting/resource-usage** [R] scope: read:hosting
  Get an account's resource usage
  params: input*
  page: https://api.inleed.com/reference/hosting/get-resource-usage.md
- **GET /api/v1/hosting/usage/history** [R] scope: read:hosting
  Get an account's usage history (degrades where unavailable)
  params: input*, period
  page: https://api.inleed.com/reference/hosting/get-hosting-usage-history.md
- **GET /api/v1/hosting/account** [R] scope: read:hosting
  Get the hosting account for a domain
  params: input*
  page: https://api.inleed.com/reference/hosting/get-hosting-account.md
- **GET /api/v1/hosting/httpd-config** [R] scope: read:hosting
  Get the web-server config summary for a domain
  params: input*
  page: https://api.inleed.com/reference/hosting/get-httpd-config.md
- **GET /api/v1/hosting/pointers** [R] scope: read:hosting
  List domain pointers
  params: input*
  page: https://api.inleed.com/reference/hosting/list-domain-pointers.md
- **GET /api/v1/hosting/resources** [R] scope: read:hosting
  List one kind of hosting resource
  params: input*, kind*, limit
  page: https://api.inleed.com/reference/hosting/list-hosting-resources.md
- **GET /api/v1/hosting/subdomains** [R] scope: read:hosting
  List subdomains
  params: input*
  page: https://api.inleed.com/reference/hosting/list-subdomains.md
- **GET /api/v1/hosting** [R] scope: read:hosting
  List the user's hosting accounts
  page: https://api.inleed.com/reference/hosting/list-hosting-accounts.md
- **GET /api/v1/hosting/redirects** [R] scope: read:hosting
  List, create or delete URL redirects
  params: input*, action*, from, to, type
  page: https://api.inleed.com/reference/hosting/manage-redirects.md
- **GET /api/v1/hosting/domains** [R] scope: read:hosting
  List, create or update addon domains
  params: input*, action*, domain, php, cgi, ssl
  page: https://api.inleed.com/reference/hosting/manage-addon-domains.md
- **GET /api/v1/hosting/hotlink-protection** [R] scope: read:hosting
  Read or set hotlink protection
  params: input*, enabled, extensions
  page: https://api.inleed.com/reference/hosting/manage-hotlink-protection.md
- **POST /api/v1/hosting/pointers** [W] scope: write:hosting
  Create a domain pointer
  params: input*, from*, type
  page: https://api.inleed.com/reference/hosting/create-domain-pointer.md
- **POST /api/v1/hosting/subdomains** [W] scope: write:hosting
  Create a subdomain
  params: input*, label*
  page: https://api.inleed.com/reference/hosting/create-subdomain.md
- **POST /api/v1/hosting/redirects** [W] scope: read:hosting
  List, create or delete URL redirects
  params: input*, action*, from, to, type
  page: https://api.inleed.com/reference/hosting/create-redirects.md
- **POST /api/v1/hosting/domains** [W] scope: read:hosting
  List, create or update addon domains
  params: input*, action*, domain, php, cgi, ssl
  page: https://api.inleed.com/reference/hosting/create-addon-domains.md
- **POST /api/v1/hosting-sso/actions/login-link** [W] scope: read:hosting + sso:hosting
  Single-use DirectAdmin login URL
  params: input*
  page: https://api.inleed.com/reference/hosting/post.md
- **POST /api/v1/hosting/actions/temporary-url** [W] scope: read:hosting
  Temporary preview URL for a domain
  params: input*, domain
  page: https://api.inleed.com/reference/hosting/create-temporary-url.md
- **PUT /api/v1/hosting/hotlink-protection** [W] scope: write:hosting
  Read or set hotlink protection
  params: input*, enabled, extensions
  page: https://api.inleed.com/reference/hosting/update-hotlink-protection.md
- **PATCH /api/v1/hosting/domains** [W] scope: read:hosting
  List, create or update addon domains
  params: input*, action*, domain, php, cgi, ssl
  page: https://api.inleed.com/reference/hosting/update-addon-domains.md
- **DELETE /api/v1/hosting/pointers** [W] scope: write:hosting
  Delete a domain pointer
  params: input*
  page: https://api.inleed.com/reference/hosting/delete-domain-pointer.md
- **DELETE /api/v1/hosting/domains** [W] scope: delete:hosting + write:hosting
  Hold an addon-domain deletion for confirmation
  params: input*, domain*, attempt_key
  page: https://api.inleed.com/reference/hosting/delete-addon-domain.md
- **DELETE /api/v1/hosting/redirects** [W] scope: read:hosting
  List, create or delete URL redirects
  params: input*, action*, from, to, type
  page: https://api.inleed.com/reference/hosting/delete-redirects.md

### 9. Email — 41 endpoints

Mailboxes, quotas, forwarders, autoresponders, vacation and delivery tracing.

- **GET /api/v1/email/deliverability** [R] scope: read:email
  Check email deliverability (SPF/DKIM/DMARC/MX)
  params: input*
  page: https://api.inleed.com/reference/email/check-email-deliverability.md
- **GET /api/v1/email/dkim** [R] scope: read:email
  Get DKIM state (or attempt to enable it)
  params: input*
  page: https://api.inleed.com/reference/email/manage-dkim.md
- **GET /api/v1/email/settings** [R] scope: read:email
  Get mail-client (IMAP/POP/SMTP) settings
  params: address*
  page: https://api.inleed.com/reference/email/get-email-settings.md
- **GET /api/v1/email/account** [R] scope: read:email
  Get one mailbox's usage and limits
  params: address*
  page: https://api.inleed.com/reference/email/get-mailbox.md
- **GET /api/v1/email/spam-settings** [R] scope: read:email
  Get or update SpamAssassin settings
  params: input*, enabled, required_score, high_score, block_high_score, rewrite_subject, subject_tag, blacklist_from[], whitelist_from[]
  page: https://api.inleed.com/reference/email/manage-spam-settings.md
- **GET /api/v1/email/catch-all** [R] scope: read:email
  Get the catch-all mode
  params: input*
  page: https://api.inleed.com/reference/email/get-catch-all.md
- **GET /api/v1/email/messages/folders** [R] scope: contents:email + read:email
  List a mailbox's folders with unread counts
  params: address*
  page: https://api.inleed.com/reference/email/list-mail-folders.md
- **GET /api/v1/email/autoresponders** [R] scope: read:email
  List autoresponders
  params: input*
  page: https://api.inleed.com/reference/email/list-autoresponders.md
- **GET /api/v1/email/usage** [R] scope: read:email
  List mailboxes by usage
  params: input*, limit
  page: https://api.inleed.com/reference/email/get-mailbox-usage.md
- **GET /api/v1/email/accounts** [R] scope: read:email
  List mailboxes with usage and quota
  params: input*, limit
  page: https://api.inleed.com/reference/email/list-mailboxes.md
- **GET /api/v1/email/vacation** [R] scope: read:email
  List vacation messages
  params: input*
  page: https://api.inleed.com/reference/email/list-vacation-messages.md
- **GET /api/v1/email/filters** [R] scope: read:email
  List, add or remove mail-filter rules
  params: input*, type, value, id
  page: https://api.inleed.com/reference/email/manage-filters.md
- **GET /api/v1/email/forwarders** [W] scope: read:email
  List, create or delete email forwarders
  params: input*, action*, address, destinations[]
  page: https://api.inleed.com/reference/email/manage-forwarders.md
- **GET /api/v1/email/mx-probe** [R] scope: read:email
  Probe a domain's mail exchangers over live SMTP
  params: domain*
  page: https://api.inleed.com/reference/email/probe-mx.md
- **GET /api/v1/email/logs** [R] scope: read:email
  Read mail-log lines for a mailbox
  params: input*, contains, lines
  page: https://api.inleed.com/reference/email/email-logs.md
- **GET /api/v1/email/messages/detail** [R] scope: read:email
  Read one email message
  params: address*, uid*, folder, attempt_key
  page: https://api.inleed.com/reference/email/read-email-message.md
- **GET /api/v1/email/messages** [R] scope: contents:email + read:email
  Search or list messages in a mail folder
  params: address*, folder, text, from, to, subject, since, before, unseen, limit, offset
  page: https://api.inleed.com/reference/email/search-mail.md
- **GET /api/v1/email/queue** [R] scope: read:email
  Show the mail queue
  params: input*, limit
  page: https://api.inleed.com/reference/email/mail-queue.md
- **GET /api/v1/email/trace** [R] scope: read:email
  Trace what happened to a message
  params: input*, days, limit
  page: https://api.inleed.com/reference/email/trace-email.md
- **POST /api/v1/email/accounts** [W] scope: write:email
  Create a mailbox
  params: input, address*, password*, quota_mb
  page: https://api.inleed.com/reference/email/create-mailbox.md
- **POST /api/v1/email/account/actions/webmail-sso** [W] scope: write:email
  Get the webmail login page for a mailbox
  params: address*
  page: https://api.inleed.com/reference/email/webmail-sso.md
- **POST /api/v1/email/filters** [W] scope: write:email
  List, add or remove mail-filter rules
  params: input*, type*, value*, id
  page: https://api.inleed.com/reference/email/create-filters.md
- **POST /api/v1/email/forwarders** [W] scope: read:email
  List, create or delete email forwarders
  params: input*, action*, address, destinations
  page: https://api.inleed.com/reference/email/create-forwarders.md
- **POST /api/v1/email/autoresponders** [W] scope: read:email
  List, create, update or delete autoresponders
  params: input*, action*, address, text, cc
  page: https://api.inleed.com/reference/email/manage-autoresponders.md
- **POST /api/v1/email/vacation** [W] scope: read:email
  List, create, update or delete vacation messages
  params: input*, action*, address, text, start_date, end_date, start_time, end_time, cc
  page: https://api.inleed.com/reference/email/manage-vacation.md
- **POST /api/v1/email/messages/actions/organize** [W] scope: contents:email + read:email
  Move, flag, trash or organize messages and folders
  params: address*, action*, folder, destination, uids
  page: https://api.inleed.com/reference/email/organize-mail.md
- **POST /api/v1/email/account/actions/suspend** [W] scope: write:email
  Suspend or unsuspend a mailbox
  params: address*
  page: https://api.inleed.com/reference/email/suspend-mailbox.md
- **PUT /api/v1/email/accounts/password** [W] scope: write:email
  Change a mailbox password
  params: address*, password*
  page: https://api.inleed.com/reference/email/set-mailbox-password.md
- **PUT /api/v1/email/dkim** [W] scope: write:email
  Get DKIM state (or attempt to enable it)
  params: input*
  page: https://api.inleed.com/reference/email/update-dkim.md
- **PUT /api/v1/email/spam-settings** [W] scope: write:email
  Get or update SpamAssassin settings
  params: input*, enabled, required_score, high_score, block_high_score, rewrite_subject, subject_tag, blacklist_from, whitelist_from
  page: https://api.inleed.com/reference/email/update-spam-settings.md
- **PUT /api/v1/email/autoresponders** [W] scope: read:email
  List, create, update or delete autoresponders
  params: input*, action*, address, text, cc
  page: https://api.inleed.com/reference/email/update-autoresponders.md
- **PUT /api/v1/email/vacation** [W] scope: read:email
  List, create, update or delete vacation messages
  params: input*, action*, address, text, start_date, end_date, start_time, end_time, cc
  page: https://api.inleed.com/reference/email/update-vacation.md
- **PUT /api/v1/email/catch-all** [W] scope: write:email
  Set the catch-all mode
  params: input*, mode*, address
  page: https://api.inleed.com/reference/email/set-catch-all.md
- **PATCH /api/v1/email/accounts/quota** [W] scope: write:email
  Change a mailbox quota
  params: address*, quota_mb*
  page: https://api.inleed.com/reference/email/set-mailbox-quota.md
- **PATCH /api/v1/email/account** [W] scope: write:email
  Change a mailbox send limit or quota
  params: address*, quota_mb, send_limit, new_name
  page: https://api.inleed.com/reference/email/update-mailbox.md
- **DELETE /api/v1/email/account** [W] scope: delete:hosting + write:email
  Hold a mailbox deletion for confirmation
  params: address*, attempt_key
  page: https://api.inleed.com/reference/email/delete-mailbox.md
- **DELETE /api/v1/email/filters** [W] scope: write:email
  List, add or remove mail-filter rules
  params: input*, type, value, id*
  page: https://api.inleed.com/reference/email/delete-filters.md
- **DELETE /api/v1/email/forwarders** [W] scope: read:email
  List, create or delete email forwarders
  params: input*, action*, address, destinations[]
  page: https://api.inleed.com/reference/email/delete-forwarders.md
- **DELETE /api/v1/email/autoresponders** [W] scope: read:email
  List, create, update or delete autoresponders
  params: input*, action*, address, text, cc
  page: https://api.inleed.com/reference/email/delete-autoresponders.md
- **DELETE /api/v1/email/vacation** [W] scope: read:email
  List, create, update or delete vacation messages
  params: input*, action*, address, text, start_date, end_date, start_time, end_time, cc
  page: https://api.inleed.com/reference/email/delete-vacation.md
- **DELETE /api/v1/email/account/actions/suspend** [W] scope: write:email
  Suspend or unsuspend a mailbox
  params: address*
  page: https://api.inleed.com/reference/email/delete-suspend-mailbox.md

### 10. Databases — 17 endpoints

MySQL databases, users, sizes and single-use phpMyAdmin links.

- **GET /api/v1/databases/{database}/backups** [R] scope: read:database
  List a database's separate backups
  params: database*, input*, database*
  page: https://api.inleed.com/reference/databases/list-database-backups.md
- **GET /api/v1/database-users** [R] scope: read:database
  List database users
  params: input*
  page: https://api.inleed.com/reference/databases/list-database-users.md
- **GET /api/v1/databases/sizes** [R] scope: read:database
  List databases by size
  params: input*, limit
  page: https://api.inleed.com/reference/databases/list-database-sizes.md
- **GET /api/v1/databases** [R] scope: read:database
  List databases with their users
  params: input*, limit
  page: https://api.inleed.com/reference/databases/list-databases.md
- **GET /api/v1/databases/{database}/access-hosts** [R] scope: read:database
  Read, add or remove database-user access hosts
  params: database*, input*, database*, user*, host
  page: https://api.inleed.com/reference/databases/manage-database-access-hosts.md
- **GET /api/v1/database-users/{username}/privileges** [R] scope: read:database
  Read, grant or revoke database-user privileges
  params: username*, input*, user*, database, privilege
  page: https://api.inleed.com/reference/databases/manage-database-user-privileges.md
- **GET /api/v1/databases/{database}** [R] scope: read:database
  Show one database with its users
  params: database*, input*, database*
  page: https://api.inleed.com/reference/databases/get-database.md
- **POST /api/v1/databases** [W] scope: write:database
  Create a database and its user
  params: input*, name*, user*, password*
  page: https://api.inleed.com/reference/databases/create-database.md
- **POST /api/v1/database-users** [W] scope: write:database
  Create a database user on an existing database
  params: input*
  page: https://api.inleed.com/reference/databases/create-database-user.md
- **POST /api/v1/databases/actions/phpmyadmin-sso** [W] scope: read:database + sso:hosting
  Create a phpMyAdmin login link
  params: input*, database
  page: https://api.inleed.com/reference/databases/create-php-my-admin-link.md
- **POST /api/v1/databases/{database}/access-hosts** [W] scope: write:database
  Read, add or remove database-user access hosts
  params: database*, input*, database*, user*, host*
  page: https://api.inleed.com/reference/databases/create-database-access-hosts.md
- **POST /api/v1/database-users/{username}/privileges** [W] scope: write:database
  Read, grant or revoke database-user privileges
  params: username*, input*, user*, database*, privilege*
  page: https://api.inleed.com/reference/databases/create-database-user-privileges.md
- **PUT /api/v1/database-users/password** [W] scope: write:database
  Change a database user's password
  params: input*, user*, password*
  page: https://api.inleed.com/reference/databases/set-database-user-password.md
- **DELETE /api/v1/databases/{database}** [W] scope: delete:hosting + write:database
  Hold a database drop for confirmation
  params: database*, input*, database*, attempt_key
  page: https://api.inleed.com/reference/databases/drop-database.md
- **DELETE /api/v1/database-users/{username}** [W] scope: write:database
  Hold a database-user deletion for confirmation
  params: username*, input*, attempt_key
  page: https://api.inleed.com/reference/databases/delete-database-user.md
- **DELETE /api/v1/databases/{database}/access-hosts** [W] scope: write:database
  Read, add or remove database-user access hosts
  params: database*, input*, database*, user*, host*
  page: https://api.inleed.com/reference/databases/delete-database-access-hosts.md
- **DELETE /api/v1/database-users/{username}/privileges** [W] scope: write:database
  Read, grant or revoke database-user privileges
  params: username*, input*, user*, database*, privilege*
  page: https://api.inleed.com/reference/databases/delete-database-user-privileges.md

### 11. FTP & SSH access — 9 endpoints

FTP accounts, SSH keys and shell access state.

- **GET /api/v1/hosting/ssh-keys** [R] scope: read:hosting
  List, add or remove SSH public keys
  params: input*, action*, public_key, fingerprint
  page: https://api.inleed.com/reference/access/manage-ssh-keys.md
- **GET /api/v1/hosting/ftp** [R] scope: read:hosting
  List, create, delete or re-password FTP accounts
  params: input*, action*, account, password, path
  page: https://api.inleed.com/reference/access/manage-ftp-accounts.md
- **POST /api/v1/hosting/ssh-keys** [W] scope: read:hosting
  List, add or remove SSH public keys
  params: input*, action*, public_key, fingerprint
  page: https://api.inleed.com/reference/access/create-ssh-keys.md
- **POST /api/v1/hosting/ssh-keys/authorize** [W] scope: read:hosting
  List, add or remove SSH public keys
  params: input*, action*, public_key, fingerprint
  page: https://api.inleed.com/reference/access/create-ssh-keys-2.md
- **POST /api/v1/hosting/ftp** [W] scope: read:hosting
  List, create, delete or re-password FTP accounts
  params: input*, action*, account, password, path
  page: https://api.inleed.com/reference/access/create-ftp-accounts.md
- **PUT /api/v1/hosting/ssh** [W] scope: write:hosting
  Hold an SSH-access change for confirmation
  params: input*, enabled*, attempt_key
  page: https://api.inleed.com/reference/access/set-ssh-access.md
- **PUT /api/v1/hosting/ftp** [W] scope: read:hosting
  List, create, delete or re-password FTP accounts
  params: input*, action*, account, password, path
  page: https://api.inleed.com/reference/access/update-ftp-accounts.md
- **DELETE /api/v1/hosting/ssh-keys** [W] scope: read:hosting
  List, add or remove SSH public keys
  params: input*, action*, public_key, fingerprint
  page: https://api.inleed.com/reference/access/delete-ssh-keys.md
- **DELETE /api/v1/hosting/ftp** [W] scope: read:hosting
  List, create, delete or re-password FTP accounts
  params: input*, action*, account, password, path
  page: https://api.inleed.com/reference/access/delete-ftp-accounts.md

### 12. SSL / TLS — 11 endpoints

Certificate status and Let’s Encrypt issuance.

- **GET /api/v1/ssl/detail** [R] scope: read:hosting
  Deep SSL certificate detail for a domain
  params: input*
  page: https://api.inleed.com/reference/ssl/get-ssl-detail.md
- **GET /api/v1/ssl** [R] scope: read:hosting
  SSL certificate status for a domain
  params: input*
  page: https://api.inleed.com/reference/ssl/get-ssl-status.md
- **GET /api/v1/ssl/actions/request-letsencrypt** [R] scope: read:hosting
  Which hostnames would validate for Let's Encrypt
  params: input*
  page: https://api.inleed.com/reference/ssl/precheck-lets-encrypt.md
- **POST /api/v1/ssl/actions/create-csr** [W] scope: write:hosting
  Generate a certificate signing request (not available)
  params: input*
  page: https://api.inleed.com/reference/ssl/create-csr.md
- **POST /api/v1/ssl/actions/request-letsencrypt** [W] scope: write:hosting
  Issue a Let's Encrypt certificate
  params: input*, include_www, include_mail
  page: https://api.inleed.com/reference/ssl/request-ssl-certificate.md
- **PUT /api/v1/ssl/auto-renew** [W] scope: write:hosting
  Enable or disable Let's Encrypt auto-renewal
  params: input*, enabled*
  page: https://api.inleed.com/reference/ssl/set-auto-renew.md
- **PUT /api/v1/ssl/force-https** [W] scope: write:hosting
  Enable or disable the HTTPS redirect
  params: input*, enabled*
  page: https://api.inleed.com/reference/ssl/set-force-https.md
- **PUT /api/v1/ssl/hsts** [W] scope: write:hosting
  Hold an HSTS change for confirmation
  params: input*, enabled*, max_age, include_subdomains, attempt_key
  page: https://api.inleed.com/reference/ssl/set-hsts.md
- **PUT /api/v1/ssl/certificate** [W] scope: write:hosting
  Install a certificate
  params: input*, certificate*, private_key*, ca_bundle
  page: https://api.inleed.com/reference/ssl/install-certificate.md
- **PUT /api/v1/ssl/ca-bundle** [W] scope: write:hosting
  Install the CA root/intermediate bundle
  params: input*, ca_bundle*
  page: https://api.inleed.com/reference/ssl/set-ca-bundle.md
- **DELETE /api/v1/ssl/certificate** [W] scope: write:hosting
  Hold a certificate removal for confirmation
  params: input*, attempt_key
  page: https://api.inleed.com/reference/ssl/delete-certificate.md

### 13. PHP & runtime — 6 endpoints

Per-domain PHP version, handler and extensions.

- **GET /api/v1/hosting/php** [R] scope: read:hosting
  Get the PHP settings for a domain
  params: input*
  page: https://api.inleed.com/reference/php/get-php-settings.md
- **GET /api/v1/php/extensions** [R] scope: read:hosting
  List or change an account's PHP extensions
  params: input*, action*, extensions[]*, version
  page: https://api.inleed.com/reference/php/manage-php-extensions.md
- **GET /api/v1/php/versions** [R] scope: read:hosting
  List the PHP versions this account's node offers
  params: input*
  page: https://api.inleed.com/reference/php/list-php-versions.md
- **PUT /api/v1/php/extensions** [W] scope: read:hosting
  List or change an account's PHP extensions
  params: input*, action*, extensions, version
  page: https://api.inleed.com/reference/php/update-php-extensions.md
- **PUT /api/v1/php/settings** [W] scope: write:hosting
  Set an account's php.ini overrides (CloudLinux PHP Selector)
  params: input*, version, settings*
  page: https://api.inleed.com/reference/php/set-php-settings.md
- **PUT /api/v1/hosting/php** [W] scope: write:hosting
  Set the PHP version
  params: input*, version*
  page: https://api.inleed.com/reference/php/set-php-version.md

### 14. Cron jobs — 5 endpoints

Scheduled tasks on the hosting account.

- **GET /api/v1/cron/jobs** [W] scope: read:hosting
  List, create, update or delete cron jobs
  params: input*, action
  page: https://api.inleed.com/reference/cron/manage-cron-jobs.md
- **POST /api/v1/cron/jobs** [W] scope: read:hosting
  List, create, update or delete cron jobs
  params: input*, action, schedule, command, cron_id
  page: https://api.inleed.com/reference/cron/create-cron-jobs.md
- **PUT /api/v1/cron/jobs** [W] scope: read:hosting
  List, create, update or delete cron jobs
  params: input*, action, schedule, command, cron_id
  page: https://api.inleed.com/reference/cron/update-cron-jobs.md
- **PUT /api/v1/cron/notification-email** [W] scope: write:hosting
  Set the cron notification email
  params: input*, email*
  page: https://api.inleed.com/reference/cron/set-cron-notification-email.md
- **DELETE /api/v1/cron/jobs** [W] scope: read:hosting
  List, create, update or delete cron jobs
  params: input*, action
  page: https://api.inleed.com/reference/cron/delete-cron-jobs.md

### 15. File manager — 12 endpoints

Directory listings, disk usage by path, and archive operations.

- **GET /api/v1/files** [R] scope: read:files
  List the files and directories in one folder
  params: input*, path
  page: https://api.inleed.com/reference/files/list-files.md
- **GET /api/v1/files/download** [R] scope: read:hosting
  Raw file download — unavailable over the DirectAdmin transport
  params: input*, path*
  page: https://api.inleed.com/reference/files/download-file.md
- **GET /api/v1/files/content** [R] scope: read:files
  
  params: input*
  page: https://api.inleed.com/reference/files/read-file.md
- **POST /api/v1/files/compress** [W] scope: write:files
  Compress a path into an archive, or extract an archive
  params: input*, action*, source, archive, destination
  page: https://api.inleed.com/reference/files/archive-files.md
- **POST /api/v1/files/extract** [W] scope: write:files
  Compress a path into an archive, or extract an archive
  params: input*, action*, source, archive, destination
  page: https://api.inleed.com/reference/files/create-archive-files.md
- **POST /api/v1/files/upload** [W] scope: write:hosting
  Upload a file into the hosting account
  params: input*, path*, content*, encoding
  page: https://api.inleed.com/reference/files/upload-file.md
- **POST /api/v1/files/mkdir** [W] scope: write:files
  Write a file, make a directory, copy, move or set permissions
  params: input*, action*, path, content, source, destination, mode
  page: https://api.inleed.com/reference/files/create-files.md
- **POST /api/v1/files/copy** [W] scope: write:files
  Write a file, make a directory, copy, move or set permissions
  params: input*, action*, path, content, source, destination, mode
  page: https://api.inleed.com/reference/files/create-files-2.md
- **POST /api/v1/files/move** [W] scope: write:files
  Write a file, make a directory, copy, move or set permissions
  params: input*, action*, path, content, source, destination, mode
  page: https://api.inleed.com/reference/files/create-files-3.md
- **PUT /api/v1/files/content** [W] scope: write:files
  Write a file, make a directory, copy, move or set permissions
  params: input*, action*, path, content, source, destination, mode
  page: https://api.inleed.com/reference/files/manage-files.md
- **PUT /api/v1/files/permissions** [W] scope: write:files
  Write a file, make a directory, copy, move or set permissions
  params: input*, action*, path, content, source, destination, mode
  page: https://api.inleed.com/reference/files/update-files.md
- **DELETE /api/v1/files** [W] scope: write:hosting
  Hold a file deletion for confirmation
  params: input*, attempt_key
  page: https://api.inleed.com/reference/files/delete-file.md

### 16. Backups & restores — 9 endpoints

Available restore points and the confirmation-tier restore flow.

- **GET /api/v1/backups** [R] scope: read:hosting
  Existing hosting backups for an account
  params: input*, limit
  page: https://api.inleed.com/reference/backups/list-backups.md
- **GET /api/v1/backups/schedule** [R] scope: read:hosting
  Get the account backup schedule
  page: https://api.inleed.com/reference/backups/get-backup-schedule.md
- **GET /api/v1/backups/account** [R] scope: read:hosting
  List the account's backup records
  page: https://api.inleed.com/reference/backups/list-account-backups.md
- **GET /api/v1/backups/restores** [R] scope: read:hosting
  Restore progress and outcome
  params: input*, restore_id, limit
  page: https://api.inleed.com/reference/backups/get-restore-status.md
- **GET /api/v1/backups/restores/{restore}** [R] scope: read:hosting
  Restore progress and outcome
  params: restore*, input*, restore_id, limit
  page: https://api.inleed.com/reference/backups/list-restore-status.md
- **GET /api/v1/backups/{backup}/contents** [R] scope: read:hosting
  What is inside one backup
  params: backup*, input*, backup_id*, item_id, path
  page: https://api.inleed.com/reference/backups/get-backup-contents.md
- **POST /api/v1/backups/restore** [W] scope: restore:hosting + write:hosting
  Hold a backup restore for confirmation
  params: input*, backup_id*, items, item_ids, paths, merge, attempt_key
  page: https://api.inleed.com/reference/backups/restore-backup.md
- **POST /api/v1/backups/restores/{restore}/cancel** [W] scope: restore:hosting + write:hosting
  Stop a running restore
  params: restore*, input*, restore_id*
  page: https://api.inleed.com/reference/backups/cancel-restore.md
- **PUT /api/v1/backups/schedule** [W] scope: write:hosting
  Report backup scheduling as not settable through the API
  page: https://api.inleed.com/reference/backups/set-backup-schedule.md

### 17. Applications — 42 endpoints

WordPress, Installatron and LiteSpeed cache management.

- **GET /api/v1/wordpress/site** [R] scope: read:hosting
  Get a WordPress site's status or run a site-wide action
  params: input*
  page: https://api.inleed.com/reference/applications/manage-wordpress-site.md
- **GET /api/v1/wordpress/installs/detail** [R] scope: read:hosting
  Get one WordPress install's detail
  params: input*, install_id*
  page: https://api.inleed.com/reference/applications/get-wordpress-install.md
- **GET /api/v1/wordpress/litespeed** [R] scope: read:hosting
  Get the LiteSpeed cache status for a domain
  params: input*, domain
  page: https://api.inleed.com/reference/applications/get-litespeed-cache-status.md
- **GET /api/v1/apps/backups** [R] scope: read:hosting
  List application backups
  params: input*, app_id
  page: https://api.inleed.com/reference/applications/list-app-backups.md
- **GET /api/v1/apps** [R] scope: read:hosting
  List the account's Installatron applications
  params: input*
  page: https://api.inleed.com/reference/applications/list-apps.md
- **GET /api/v1/wordpress/installs** [R] scope: read:hosting
  List the account's WordPress installs
  params: input*
  page: https://api.inleed.com/reference/applications/list-wordpress-installs.md
- **GET /api/v1/apps/available** [R] scope: read:hosting
  List the applications Installatron can install
  params: input*
  page: https://api.inleed.com/reference/applications/list-available-apps.md
- **GET /api/v1/wordpress/users** [R] scope: read:hosting
  List, create or re-role WordPress users
  params: input*
  page: https://api.inleed.com/reference/applications/manage-wordpress-users.md
- **GET /api/v1/wordpress/themes** [R] scope: read:hosting
  List, install, activate, update or delete WordPress themes
  params: input*
  page: https://api.inleed.com/reference/applications/manage-wordpress-themes.md
- **GET /api/v1/wordpress/plugins** [R] scope: read:hosting
  List, install, update, toggle or uninstall WordPress plugins
  params: input*, action*, slug, path, activate
  page: https://api.inleed.com/reference/applications/manage-wordpress-plugins.md
- **GET /api/v1/wordpress/content** [R] scope: read:hosting
  List, read, create, update or trash WordPress pages and posts
  params: input*
  page: https://api.inleed.com/reference/applications/manage-wordpress-content.md
- **GET /api/v1/wordpress/content/detail** [R] scope: read:hosting
  List, read, create, update or trash WordPress pages and posts
  params: input*
  page: https://api.inleed.com/reference/applications/list-wordpress-content.md
- **GET /api/v1/apps/activity** [R] scope: read:hosting
  Read Installatron activity and running tasks
  params: input*, install, severity, days, limit
  page: https://api.inleed.com/reference/applications/get-app-activity.md
- **GET /api/v1/wordpress/settings** [R] scope: read:hosting
  Read or change WordPress settings
  params: input*
  page: https://api.inleed.com/reference/applications/manage-wordpress-settings.md
- **GET /api/v1/apps/detail** [R] scope: read:hosting
  Read, install, update, back up, log in to, configure or uninstall an Installatron application
  params: input*
  page: https://api.inleed.com/reference/applications/list-app.md
- **POST /api/v1/wordpress/clone** [W] scope: write:hosting
  Clone a WordPress install to a new location
  params: input*, install_id*, target_domain*, target_path
  page: https://api.inleed.com/reference/applications/clone-wordpress.md
- **POST /api/v1/wordpress/staging** [W] scope: write:hosting
  Create or push a WordPress staging copy
  params: input*, install_id*, action*, staging_id, target_domain, target_path, attempt_key
  page: https://api.inleed.com/reference/applications/manage-wordpress-staging.md
- **POST /api/v1/wordpress/site** [W] scope: write:hosting
  Get a WordPress site's status or run a site-wide action
  params: input*
  page: https://api.inleed.com/reference/applications/create-wordpress-site.md
- **POST /api/v1/wordpress/admin-password-reset** [W] scope: write:hosting
  Hold a WordPress admin password reset for confirmation
  params: input*, path, attempt_key
  page: https://api.inleed.com/reference/applications/reset-wordpress-admin-password.md
- **POST /api/v1/wordpress/restore** [W] scope: restore:hosting + write:hosting
  Hold a WordPress restore for confirmation
  params: input*, install_id*, backup_id*, attempt_key
  page: https://api.inleed.com/reference/applications/restore-wordpress.md
- **POST /api/v1/wordpress/import** [W] scope: write:hosting
  Import a site into Installatron — from this account or a remote server
  params: input*, source*, domain*, application, path, source_url, source_path, source_url_ip
  page: https://api.inleed.com/reference/applications/import-wordpress.md
- **POST /api/v1/wordpress/install** [W] scope: write:hosting
  Install WordPress on a domain
  params: input*, domain, path, title, admin_username, admin_email
  page: https://api.inleed.com/reference/applications/install-wordpress.md
- **POST /api/v1/wordpress/users** [W] scope: write:hosting
  List, create or re-role WordPress users
  params: input*
  page: https://api.inleed.com/reference/applications/create-wordpress-users.md
- **POST /api/v1/wordpress/themes** [W] scope: write:hosting
  List, install, activate, update or delete WordPress themes
  params: input*
  page: https://api.inleed.com/reference/applications/create-wordpress-themes.md
- **POST /api/v1/wordpress/plugins** [W] scope: write:hosting
  List, install, update, toggle or uninstall WordPress plugins
  params: input*, action*, slug, path, activate
  page: https://api.inleed.com/reference/applications/create-wordpress-plugins.md
- **POST /api/v1/wordpress/content** [W] scope: write:hosting
  List, read, create, update or trash WordPress pages and posts
  params: input*
  page: https://api.inleed.com/reference/applications/create-wordpress-content.md
- **POST /api/v1/wordpress/admin-link** [W] scope: read:hosting + sso:hosting
  Mint a one-time wp-admin login URL
  params: input*, install_id, path, url
  page: https://api.inleed.com/reference/applications/create-wordpress-admin-link.md
- **POST /api/v1/wordpress/litespeed/purge** [W] scope: write:hosting
  Purge the LiteSpeed cache for a domain
  params: input*, domain
  page: https://api.inleed.com/reference/applications/purge-litespeed-cache.md
- **POST /api/v1/apps** [W] scope: read:hosting
  Read, install, update, back up, log in to, configure or uninstall an Installatron application
  params: input*, action*, app_id, url, backup_id, application, title, admin_username, admin_email, version, path, autoup, autoup_plugins, autoup_themes, autoup_backup, attempt_key
  page: https://api.inleed.com/reference/applications/manage-app.md
- **POST /api/v1/apps/actions/backup** [W] scope: read:hosting
  Read, install, update, back up, log in to, configure or uninstall an Installatron application
  params: input*, action*, app_id, url, backup_id, application, title, admin_username, admin_email, version, path, autoup, autoup_plugins, autoup_themes, autoup_backup, attempt_key
  page: https://api.inleed.com/reference/applications/create-app.md
- **POST /api/v1/apps/actions/sso** [W] scope: read:hosting
  Read, install, update, back up, log in to, configure or uninstall an Installatron application
  params: input*, action*, app_id, url, backup_id, application, title, admin_username, admin_email, version, path, autoup, autoup_plugins, autoup_themes, autoup_backup, attempt_key
  page: https://api.inleed.com/reference/applications/create-app-2.md
- **POST /api/v1/wordpress/database/query** [W] scope: write:hosting
  Run one read-only SQL statement on a WordPress site's database
  params: input*
  page: https://api.inleed.com/reference/applications/query-wordpress-database.md
- **PUT /api/v1/wordpress/settings** [W] scope: write:hosting
  Read or change WordPress settings
  params: input*
  page: https://api.inleed.com/reference/applications/update-wordpress-settings.md
- **PATCH /api/v1/wordpress/users** [W] scope: write:hosting
  List, create or re-role WordPress users
  params: input*
  page: https://api.inleed.com/reference/applications/update-wordpress-users.md
- **PATCH /api/v1/wordpress/themes** [W] scope: write:hosting
  List, install, activate, update or delete WordPress themes
  params: input*
  page: https://api.inleed.com/reference/applications/update-wordpress-themes.md
- **PATCH /api/v1/wordpress/plugins** [W] scope: write:hosting
  List, install, update, toggle or uninstall WordPress plugins
  params: input*, action*, slug, path, activate
  page: https://api.inleed.com/reference/applications/update-wordpress-plugins.md
- **PATCH /api/v1/wordpress/content** [W] scope: write:hosting
  List, read, create, update or trash WordPress pages and posts
  params: input*
  page: https://api.inleed.com/reference/applications/update-wordpress-content.md
- **PATCH /api/v1/apps** [W] scope: read:hosting
  Read, install, update, back up, log in to, configure or uninstall an Installatron application
  params: input*, action*, app_id, url, backup_id, application, title, admin_username, admin_email, version, path, autoup, autoup_plugins, autoup_themes, autoup_backup, attempt_key
  page: https://api.inleed.com/reference/applications/update-app.md
- **PATCH /api/v1/apps/settings** [W] scope: read:hosting
  Read, install, update, back up, log in to, configure or uninstall an Installatron application
  params: input*, action*, app_id, url, backup_id, application, title, admin_username, admin_email, version, path, autoup, autoup_plugins, autoup_themes, autoup_backup, attempt_key
  page: https://api.inleed.com/reference/applications/update-app-2.md
- **DELETE /api/v1/apps/backups** [W] scope: write:hosting
  Delete one application backup (held for confirmation)
  params: input*, attempt_key
  page: https://api.inleed.com/reference/applications/delete-app-backup.md
- **DELETE /api/v1/wordpress/content** [W] scope: write:hosting
  List, read, create, update or trash WordPress pages and posts
  params: input*
  page: https://api.inleed.com/reference/applications/delete-wordpress-content.md
- **DELETE /api/v1/apps** [W] scope: read:hosting
  Read, install, update, back up, log in to, configure or uninstall an Installatron application
  params: input*
  page: https://api.inleed.com/reference/applications/delete-app.md

### 18. Security — 12 endpoints

IP blocks, malware findings and protected directories.

- **GET /api/v1/security/file-integrity** [R] scope: read:hosting
  Check a site's file integrity
  params: input*, path
  page: https://api.inleed.com/reference/security/get-file-integrity.md
- **GET /api/v1/security/modsecurity** [R] scope: read:hosting
  Get a domain's ModSecurity status
  params: input*
  page: https://api.inleed.com/reference/security/get-modsecurity.md
- **GET /api/v1/security/login-history** [R] scope: read:hosting
  Get a hosting account's recent login history
  params: input*, limit
  page: https://api.inleed.com/reference/security/get-login-history.md
- **GET /api/v1/security/overview** [R] scope: read:hosting
  Get a hosting account's security posture
  params: input*
  page: https://api.inleed.com/reference/security/get-security-overview.md
- **GET /api/v1/hosting/protected-directories** [R] scope: read:hosting
  List a domain's password-protected directories
  params: input*
  page: https://api.inleed.com/reference/security/list-protected-directories.md
- **GET /api/v1/security/imunify** [R] scope: read:hosting
  Read or act on Imunify360 malware findings
  params: input*
  page: https://api.inleed.com/reference/security/manage-imunify.md
- **GET /api/v1/security/imunify/findings** [R] scope: read:hosting
  Read or act on Imunify360 malware findings
  params: input*
  page: https://api.inleed.com/reference/security/list-imunify.md
- **POST /api/v1/security/imunify/scan** [W] scope: read:hosting
  Read or act on Imunify360 malware findings
  params: input*, action*, finding_id, limit, path, attempt_key
  page: https://api.inleed.com/reference/security/create-imunify.md
- **POST /api/v1/security/imunify/ignore** [W] scope: read:hosting
  Read or act on Imunify360 malware findings
  params: input*, action*, finding_id, limit, path, attempt_key
  page: https://api.inleed.com/reference/security/create-imunify-2.md
- **POST /api/v1/security/imunify/restore** [W] scope: read:hosting
  Read or act on Imunify360 malware findings
  params: input*, action*, finding_id, limit, path, attempt_key
  page: https://api.inleed.com/reference/security/create-imunify-3.md
- **PUT /api/v1/hosting/protected-directories** [W] scope: write:hosting
  Password-protect a directory
  params: input*, path*, username*, password*, realm
  page: https://api.inleed.com/reference/security/set-directory-password.md
- **DELETE /api/v1/hosting/protected-directories** [W] scope: write:hosting
  Remove password protection from a directory
  params: input*
  page: https://api.inleed.com/reference/security/delete-directory-password.md

### 19. Logs & monitoring — 9 endpoints

Error, access and email logs, and what is available to read.

- **GET /api/v1/statistics/top-pages** [R] scope: read:hosting
  Get a site's traffic, error or PHP-usage statistics
  params: input*
  page: https://api.inleed.com/reference/logs/get-site-stats.md
- **GET /api/v1/statistics/errors** [R] scope: read:hosting
  Get a site's traffic, error or PHP-usage statistics
  params: input*
  page: https://api.inleed.com/reference/logs/list-site-stats.md
- **GET /api/v1/statistics/php-usage** [R] scope: read:hosting
  Get a site's traffic, error or PHP-usage statistics
  params: input*
  page: https://api.inleed.com/reference/logs/list-site-stats-2.md
- **GET /api/v1/monitors** [R] scope: read:hosting
  List, create, delete a website monitor, or read one monitor's up/down events
  params: action*
  page: https://api.inleed.com/reference/logs/manage-monitors.md
- **GET /api/v1/monitors/{monitor}/events** [R] scope: read:hosting
  List, create, delete a website monitor, or read one monitor's up/down events
  params: monitor*, action*
  page: https://api.inleed.com/reference/logs/list-monitors.md
- **GET /api/v1/logs** [R] scope: read:hosting
  Read the tail of one log
  params: input*, kind*, contains, lines
  page: https://api.inleed.com/reference/logs/read-logs.md
- **GET /api/v1/logs/available** [R] scope: read:hosting
  Which website logs exist for a domain
  params: input*
  page: https://api.inleed.com/reference/logs/list-available-logs.md
- **POST /api/v1/monitors** [W] scope: read:hosting
  List, create, delete a website monitor, or read one monitor's up/down events
  params: action*, domain, frequency, notify_on_online, monitor_id, limit
  page: https://api.inleed.com/reference/logs/create-monitors.md
- **DELETE /api/v1/monitors/{monitor}** [W] scope: read:hosting
  List, create, delete a website monitor, or read one monitor's up/down events
  params: monitor*, action*
  page: https://api.inleed.com/reference/logs/delete-monitors.md

### 20. VPS — 9 endpoints

Power state, console, install media and server detail. Reinstall, resize, delete and snapshots are done in the client area.

- **GET /api/v1/vps/detail** [R] scope: read:vps
  Get one VPS
  params: input*
  page: https://api.inleed.com/reference/vps/get-vps.md
- **GET /api/v1/vps** [R] scope: read:vps
  List the account's VPS servers
  params: status, limit, cursor
  page: https://api.inleed.com/reference/vps/list-vps.md
- **GET /api/v1/vps/templates** [R] scope: read:vps
  List the OS templates Inleed offers for a VPS
  params: input
  page: https://api.inleed.com/reference/vps/list-vps-templates.md
- **GET /api/v1/vps/iso** [R] scope: read:services
  Report the VPS install media
  params: input*
  page: https://api.inleed.com/reference/vps/manage-vps-iso.md
- **POST /api/v1/vps/start** [W] scope: power:vps
  Boot a VPS
  params: input*
  page: https://api.inleed.com/reference/vps/start-vps.md
- **POST /api/v1/vps/stop** [W] scope: power:vps
  Hold a VPS force-stop for confirmation
  params: input*, attempt_key
  page: https://api.inleed.com/reference/vps/stop-vps.md
- **POST /api/v1/vps/reboot** [W] scope: power:vps
  Hold a VPS reboot for confirmation
  params: input*, attempt_key
  page: https://api.inleed.com/reference/vps/reboot-vps.md
- **POST /api/v1/vps/root-password** [W] scope: write:vps
  Hold a VPS root-password reset for confirmation
  params: input*, new_password*, attempt_key
  page: https://api.inleed.com/reference/vps/reset-vps-root-password.md
- **POST /api/v1/vps/console** [W] scope: console:vps
  Mint the VNC console for a VPS
  params: input*
  page: https://api.inleed.com/reference/vps/get-vps-console.md

### 21. Broadband — 2 endpoints

Fiber delivery lookup: which addresses we reach, and what the speed tiers cost there.

- **GET /api/v1/broadband/addresses** [R] scope: read:orders
  Find the addresses Inleed can deliver fiber to
  params: query*, network_id, limit
  page: https://api.inleed.com/reference/broadband/search-broadband-addresses.md
- **GET /api/v1/broadband/addresses/{address}/offers** [R] scope: read:orders
  List the broadband speeds and prices available at one address
  params: address*, address_id*, customer_type
  page: https://api.inleed.com/reference/broadband/get-broadband-offers.md

### 22. Other service types — 8 endpoints

VPN, storage, colocation and everything else on the account.

- **GET /api/v1/network/ip-ranges** [R] scope: read:services
  Read one other-service-type list for the account
  page: https://api.inleed.com/reference/other-services/get-network-service.md
- **GET /api/v1/network/ip-ranges/addresses** [R] scope: read:services
  Read one other-service-type list for the account
  page: https://api.inleed.com/reference/other-services/list-network-service.md
- **GET /api/v1/network/internet** [R] scope: read:services
  Read one other-service-type list for the account
  page: https://api.inleed.com/reference/other-services/list-network-service-2.md
- **GET /api/v1/network/internet/status** [R] scope: read:services
  Read one other-service-type list for the account
  page: https://api.inleed.com/reference/other-services/list-network-service-3.md
- **GET /api/v1/network/licences** [R] scope: read:services
  Read one other-service-type list for the account
  page: https://api.inleed.com/reference/other-services/list-network-service-4.md
- **GET /api/v1/network/storage** [R] scope: read:services
  Report a datacenter service type as not manageable through the API
  page: https://api.inleed.com/reference/other-services/get-unavailable-service.md
- **GET /api/v1/network/colocation** [R] scope: read:services
  Report a datacenter service type as not manageable through the API
  page: https://api.inleed.com/reference/other-services/list-unavailable-service.md
- **GET /api/v1/network/vpn** [R] scope: read:services
  Report a datacenter service type as not manageable through the API
  page: https://api.inleed.com/reference/other-services/list-unavailable-service-2.md

### 23. Migrations & onboarding — 5 endpoints

Inbound migration requests and their progress.

- **GET /api/v1/migrations/{migration}** [R] scope: read:services
  Get one migration request
  params: migration*, migration*
  page: https://api.inleed.com/reference/migrations/get-migration.md
- **GET /api/v1/onboarding/next-steps** [R] scope: read:services
  Get the account onboarding checklist
  page: https://api.inleed.com/reference/migrations/get.md
- **GET /api/v1/migrations** [R] scope: read:services
  List the account's migration requests
  page: https://api.inleed.com/reference/migrations/list-migrations.md
- **POST /api/v1/migrations/{migration}/actions/cancel** [W] scope: write:services
  Cancel a migration request
  params: migration*, migration*
  page: https://api.inleed.com/reference/migrations/cancel-migration.md
- **POST /api/v1/migrations** [W] scope: write:hosting
  Hold a migration request for confirmation
  params: control_panel, websites, email_accounts, domains, note, attempt_key
  page: https://api.inleed.com/reference/migrations/request-migration.md

### 24. Diagnostics — 9 endpoints

Composite reads that answer a question instead of returning raw data.

- **GET /api/v1/diagnostics/overview** [R] scope: read:account
  Get the account-health overview
  page: https://api.inleed.com/reference/diagnostics/get-diagnostics-overview.md
- **GET /api/v1/diagnostics/disk-usage** [R] scope: read:hosting
  List the largest directories under the account home
  params: input*, path, limit
  page: https://api.inleed.com/reference/diagnostics/check-disk-usage.md
- **GET /api/v1/diagnostics/ip-status** [R] scope: read:hosting
  Report whether one IP is blocked on the node, and why
  params: ip*, input
  page: https://api.inleed.com/reference/diagnostics/check-ip-blocked.md
- **GET /api/v1/diagnostics/dns** [R] scope: read:dns
  Roll up DNS health for one domain
  params: input*
  page: https://api.inleed.com/reference/diagnostics/get-dns-diagnostics.md
- **GET /api/v1/diagnostics/email** [R] scope: read:email
  Roll up email health for one target
  params: input*
  page: https://api.inleed.com/reference/diagnostics/get-email-diagnostics.md
- **GET /api/v1/diagnostics/service/{service}** [R] scope: read:services
  Roll up health for one service
  params: service*, input*
  page: https://api.inleed.com/reference/diagnostics/get-service-diagnostics.md
- **GET /api/v1/diagnostics/website** [R] scope: read:hosting
  Roll up website health for one target
  params: input*
  page: https://api.inleed.com/reference/diagnostics/get-website-diagnostics.md
- **GET /api/v1/diagnostics** [R] scope: read:hosting
  Symptom-driven triage for one target
  params: input*, symptom*
  page: https://api.inleed.com/reference/diagnostics/diagnose.md
- **POST /api/v1/diagnostics/ip-whitelist** [W] scope: write:hosting
  Unblock one IP across the node's firewalls
  params: input*, ip*
  page: https://api.inleed.com/reference/diagnostics/whitelist-ip.md

### 25. Support — 5 endpoints

Tickets, replies and attachments.

- **GET /api/v1/support/status** [R] scope: read:account
  Get support channel availability
  page: https://api.inleed.com/reference/support/get-support-status.md
- **GET /api/v1/support/contact** [R] scope: read:account
  Get the support contact channels
  page: https://api.inleed.com/reference/support/get-support-contact.md
- **GET /api/v1/support/articles** [R] scope: read:support
  Search the help centre, or read one article
  params: article_id, search, locale, limit, cursor
  page: https://api.inleed.com/reference/support/list-support-articles.md
- **GET /api/v1/support/articles/{article}** [R] scope: read:support
  Search the help centre, or read one article
  params: article*, article_id, search, locale, limit, cursor
  page: https://api.inleed.com/reference/support/list-support-articles-2.md
- **POST /api/v1/support/requests** [W] scope: write:support
  Hold a support email for confirmation
  params: subject*, message*, attempt_key
  page: https://api.inleed.com/reference/support/create-support-request.md

## MCP tools

### Orientation — 22 tools

- `account_overview` [R] scopes: read:account — Summarise the whole account in one call: who it is (name, email, company, country), how many services it holds and how many are suspended, the count and total of…
- `create_temporary_url` [W] scopes: read:hosting — Create a temporary address that shows a domain's site on our servers before the domain's DNS points here (or when the customer uses other nameservers).
- `diagnose` [R] scopes: read:hosting — First stop for a ticket: give it the customer's identifier and the symptom (`slow` | `down` | `email` | `ssl` | `dns` | `disk` | `billing`) and it runs the right…
- `fetch_web_page` [R] scopes: read:hosting — Fetch a public web page by URL and return what it says: `title`, `description`, `language`, `canonical`, `headings` (h1–h3), `text` (the readable body with scripts,…
- `get_app_activity` [R] scopes: read:hosting — Read an account's Installatron activity: `tasks[]` — currently running/queued work with `percent` progress (poll this after an async install or `import_wordpress`…
- `get_job` [R] scopes: read:account — Poll a long-running (asynchronous) operation you started.
- `get_pending_action` [R] scopes: read:account — Poll a confirmation-tier action you started (renew, cancel, change billing cycle, pay from balance, delete a mailbox, restore a backup).
- `list_account_guests` [R] scopes: read:account — List the people who have delegated access to this account.
- `list_processes` [R] scopes: read:hosting — List the running processes of a hosting account as its own user — `data[]` of `{pid, ppid, cpuPercent, memPercent, rssKb, elapsedSeconds, state, command, args}` plus…
- `list_protected_directories` [R] scopes: read:hosting — List the password-protected directories on a domain — each with its path and prompt text.
- `manage_account_guests` [D] scopes: write:account — Grant or revoke delegated access to this account.
- `manage_shell_access` [W] scopes: read:hosting — Check, enable or disable shell (SSH) access for the assistant on a hosting account — the one-time step behind `run_shell_command`, `list_processes` and `find_files`.
- `manage_two_factor` [W] scopes: write:account — Turn authenticator-app (TOTP) two-factor login on or off for this account.
- `organize_mail` [W] scopes: contents:email + read:email — Organize a mailbox: move messages between folders, mark read/unread, star/unstar (`flag`/`unflag`), move to Trash (`trash`), and create or delete folders.
- `probe_mx` [R] scopes: read:email — Probe a domain's mail exchangers over live SMTP: resolve the MX set, connect to each on port 25, read the banner, check starttls and verify the PTR (reverse DNS)…
- `request_owner_change` [R] scopes: write:domains — Quote a change of legal owner (registrant organisation) for a `.se/.nu` domain, and hand off to the signed flow.
- `resolve` [R] scopes: read:services — Resolve any identifier the account owns — a domain, email, website URL, Inleed service id or hosting-account username — to a single target: its kind, the owning…
- `run_shell_command` [D] scopes: shell:hosting — Run one shell command on the hosting account AS the account user over SSH (never as an administrator) and return `{command, cwd, exitCode, stdout, stderr, truncated,…
- `search_mail` [R] scopes: contents:email + read:email — Search or list the messages in one mail folder — returns per message the `uid`, date, size, flags, subject, sender and recipient, newest first, paged.
- `update_preferences` [W] scopes: write:account — Change this account's notification and display preferences.
- `wait_for_setup` [R] scopes: read:orders — Wait for the services of a paid order to finish being set up, so the next step (set up email, install WordPress, point a domain) can follow at once.
- `whoami` [R] scopes: read:account — Report which Inleed customer account this connection is acting as, and exactly what it is allowed to do: the numeric account id, the API token's name and expiry, the…

### Services & subscriptions — 23 tools

- `cancel_order` [D] scopes: write:orders — Cancel (delete) an unpaid order — a confirmation, never immediate: this returns `{status:"confirmation_required", confirmationUrl, preview}` and the customer approves…
- `cancel_pending_action` [W] scopes: read:account — Withdraw a confirmation you started that the customer has not approved yet — the answer to "skip that", "never mind", "don't do the nameserver change after all",…
- `cancel_service` [D] scopes: write:billing + write:services — Schedule a service for cancellation.
- `create_order` [W] scopes: write:billing + write:orders — Place a store order.
- `get_addon_suggestions` [R] scopes: read:orders — The addon services that can be ordered with one catalogue plan — per addon its name, quantity bounds, incompatibilities, and `options[]` carrying the exact…
- `get_order` [R] scopes: read:orders — Get one order in full: its invoice with line items, the `paymentUrl` to pay it (null once paid), and `provisioning[]` — the live status of each service the order creates.
- `get_renewal_quote` [R] scopes: read:billing — Quote a manual renewal for a service: the price for the chosen number of years, the new expiry date, the maximum years allowed, whether it can be renewed manually and…
- `get_service` [R] scopes: read:services — Get one service in full from any identifier the account owns: plan, price, billing period, status, expiry, metadata (domain, username, node, IP) and a `can:{}` block…
- `get_service_diagnostics` [R] scopes: read:services — Roll up everything relevant to one service in a single call, shaped by its type: it composes the service state and — for a hosting service — the DirectAdmin and SSL…
- `get_service_usage` [R] scopes: read:services — Get the billing usage snapshot for one service: its period price, renewal price, lifetime spend, days until expiry, autorenew flag and the open-invoice and addon rollups.
- `get_upgrade_options` [R] scopes: read:services — List the plans a service could be upgraded or downgraded to, each with its prorated price-to-pay over the time remaining.
- `list_cancellations` [R] scopes: read:services — List every scheduled cancellation on the account in one read: `{data:[{serviceId, type, displayName, domain, deleteServiceAt, …}], total}`.
- `list_orders` [R] scopes: read:orders — List the account's orders, newest first — by default the open ones (unpaid proforma invoices, each with a `paymentUrl`); pass `status` `paid` for orders that have…
- `list_pending_orders` [R] scopes: read:orders — List the orders still awaiting payment: `{data:[{orderId, amount, paymentUrl, nextAction, expiresAt, isExpired, services:[…]}], total, totalDue}`, where `nextAction`…
- `list_products` [R] scopes: read:orders — The purchasable product catalogue: `categories[]` (hosting, vps, vpn, domain, …) with their `types[]` (the named plans, e.g.
- `list_services` [R] scopes: read:services — List the subscriptions on the account — hosting, domains, VPS, storage and more — each with its id, type, domain, status, price, expiry and a `can:{}` block of what…
- `manage_service_addons` [W] scopes: read:services — List, add or remove the addons attached to a service.
- `preview_order` [R] scopes: read:orders — Price a cart before buying — the mandatory first step before `create_order`.
- `rename_service` [W] scopes: write:services — Rename a service's display label — the friendly name shown in listings, max 16 characters.
- `renew_service` [W] scopes: write:billing + write:services — Renew a hosting or domain service for one or more periods.
- `set_autorenew` [W] scopes: write:services — Turn automatic renewal on or off for a hosting, VPS or other non-domain service.
- `upgrade_service` [W] scopes: write:billing + write:services — Upgrade a service to a larger plan.
- `validate_order_contact` [R] scopes: read:orders — Validate the contact details an order will need — country code, phone number (E.164), Swedish person/org-number and VAT rules — before placing an order.

### Billing — 17 tools

- `add_funds` [W] scopes: write:billing — Top up the prepaid account balance.
- `change_billing_cycle` [W] scopes: write:billing — Change a service's billing period (for example monthly to yearly).
- `create_payment_link` [W] scopes: write:billing — Get the payment URL for an invoice — the anonymous pay.inleed.com page where the customer pays by card, Swish or Payson in the browser.
- `get_balance` [R] scopes: read:billing — Report the account's prepaid balance: the balance itself, its currency and how much of it is usable against open invoices (`availableToUse`, never negative).
- `get_billing_activity` [R] scopes: read:billing — Get the account's unified money timeline, newest first: invoices, credit notes, payments and balance moves in one stream.
- `get_invoice` [R] scopes: read:billing — Get one invoice in full: its line items with the service and period each covers, the payments booked against it, the net/tax/gross/unpaid totals and a `can:{}` block…
- `get_invoice_payment_methods` [R] scopes: read:billing — Get how an invoice can be paid: a `can:{}` matrix (balance, card, swish, payson, autogiro), the unpaid total, the balance available, whether autogiro is enabled, and…
- `get_invoice_pdf_link` [R] scopes: read:billing — Get a download link for an invoice PDF: the invoice id, its status and a `downloadUrl` for the PDF bytes.
- `list_invoices` [R] scopes: read:billing — List the account's invoices newest first, each with its id, status, gross and unpaid totals, and due/paid dates.
- `list_payment_methods` [R] scopes: read:billing — List the saved payment methods on this account, grouped per billing profile: masked `cards` (each `id`, `brand`, `last4`, `label`, `automaticPay`), the `autogiro`…
- `manage_billing_address_contacts` [W] scopes: read:billing — List, add or remove the contacts on a billing address — the recipients that invoice emails go to.
- `manage_billing_addresses` [W] scopes: read:billing — List or manage the account's billing addresses (billing profiles — each carries a currency, VAT number and tax identity).
- `manage_invoice_autogiro` [W] scopes: write:billing — Schedule or cancel Autogiro (Swedish direct-debit) payment of an invoice.
- `manage_payment_methods` [D] scopes: write:billing + write:payment_methods — Add or remove a saved card on this account.
- `pay_invoice_with_balance` [W] scopes: write:billing — Pay an open invoice from the account's prepaid balance.
- `pay_invoice_with_card` [W] scopes: write:billing + write:payment_methods — Pay an invoice from a saved card, off-session.
- `send_invoice` [W] scopes: write:billing — Email an invoice — the PDF and its pay link — to one specific address the customer names: "skicka fakturan till ekonomi@firma.se", "send the invoice to my…

### Hosting account — 10 tools

- `create_panel_login_link` [W] scopes: read:hosting + sso:hosting — Mint a single-use DirectAdmin control-panel login URL for a hosting account, to hand to the human so they can manage the account in the panel.
- `get_hosting_account` [R] scopes: read:hosting — Report the DirectAdmin hosting account behind a domain: `package`, `isSuspended`, disk and bandwidth as `{used, limit, unit, pct, atLimit}`, resource counts (domains,…
- `get_httpd_config` [R] scopes: read:hosting — Get the web-server (Apache/LiteSpeed vhost) configuration summary for a domain — its `documentRoot`, `serverAliases`, IP and the ssl/php/cgi flags.
- `get_php_settings` [R] scopes: read:hosting — Report the PHP runtime for a domain: the selected `version` (e.g.
- `get_resource_usage` [R] scopes: read:hosting — Get an account's resource usage — live CPU, memory, entry-process and I/O where the node runs CloudLinux/lve, and always the DirectAdmin usage summary: `disk` and…
- `list_hosting_accounts` [R] scopes: read:hosting — List every DirectAdmin hosting account this account owns, as `data[]` of `{serviceId, daUsername, node, primaryDomain, domains[], status, isSuspended}`.
- `list_hosting_resources` [R] scopes: read:hosting — List one kind of thing inside a hosting account — pick with `kind`: `domains`, `subdomains`, `pointers`, `email` (mailboxes), `forwarders`, `databases`, `ftp` or `cron`.
- `manage_redirects` [W] scopes: read:hosting — List, create or delete URL redirects on a domain — sending a path to another URL with a `301` (permanent) or `302` (temporary) status.
- `set_hosting_password` [D] scopes: write:hosting — Change the DirectAdmin control-panel (account) login password for a hosting account.
- `set_php_version` [W] scopes: write:hosting — Change the PHP version, then confirm it by reading the version back — it never reports success on an unconfirmed write.

### FTP & SSH access — 3 tools

- `manage_ftp_accounts` [W] scopes: read:hosting — List, create, delete or re-password the FTP accounts on a domain.
- `manage_ssh_keys` [W] scopes: read:hosting — List, add or remove the SSH public keys (`authorized_keys` entries) on a hosting account.
- `set_ssh_access` [D] scopes: write:hosting — Enable or disable SSH (shell) access for a whole hosting account.

### PHP & runtime — 3 tools

- `list_php_versions` [R] scopes: read:hosting — List the PHP versions the account’s hosting node offers, each with its end-of-life date, as `versions[]` of `{version, isCurrent, eol, isEol, isSecuritySupported}`…
- `manage_php_extensions` [W] scopes: read:hosting — List, enable or disable PHP extensions for a hosting account (CloudLinux PHP Selector — account-wide, not per domain).
- `set_php_settings` [W] scopes: write:hosting — Override php.ini values for a hosting account (CloudLinux PHP Selector — account-wide).

### DNS — 14 tools

- `check_dns_health` [R] scopes: read:dns — Diagnose a domain's DNS and return a verdict, not a raw dump: does the root A record point at this hosting node, is mail configured (MX present, SPF, DKIM, DMARC),…
- `check_dns_propagation` [R] scopes: read:dns — Check whether a DNS change has propagated by asking several independent public resolvers (Google, Cloudflare, AdGuard) the same question at once.
- `create_dns_record` [W] scopes: write:dns — Create one DNS record in a domain's zone and return the stored record with its new `id`.
- `delete_dns_record` [W] scopes: write:dns — Delete one DNS record, addressed by `record_id`, and confirm it is gone from the zone.
- `dns_lookup` [R] scopes: read:dns — Look up any name in the public internet DNS and return `data[]` of `{type,value,ttl,priority?}`.
- `get_dns_diagnostics` [R] scopes: read:dns — Roll up DNS health for one owned domain in a single call: it composes the authoritative zone read (what your zone says), the public-resolver lookup (what the internet…
- `get_dns_zone` [R] scopes: read:dns — Summarise one DNS zone: `counts` of records per type, `total`, `dnssecSigned`, its `nameservers`, its `mx` exchangers, and whether spf/dkim/dmarc exist.
- `get_dns_zones` [R] scopes: read:dns — List every DNS zone this account owns — the primary and addon domains across all hosting accounts, each as `{domain, isPrimary, daUsername, node, serviceId}`.
- `lint_dns_zone` [R] scopes: read:dns — Lint a DNS zone this account owns for hygiene problems a health check misses: a CNAME at the apex or shadowing other records, dangling CNAMEs, more than one SPF…
- `list_dns_records` [R] scopes: read:dns — List every DNS record in a domain's zone: each record's `id`, `type`, `name`, `value`, `ttl`, and `priority` for MX.
- `manage_dns_zone` [D] scopes: read:dns — Whole-zone DNS operations for a domain you own, chosen by `action`: `export` a bind zone file; `bulk` add/delete many records at once; `import` a bind zone file;…
- `manage_dnssec` [D] scopes: write:domains — List, add or remove a domain's DNSSEC DS records at the registrar.
- `set_nameservers` [D] scopes: write:domains — Replace a domain's authoritative nameservers at the registrar.
- `update_dns_record` [W] scopes: write:dns — Change the value, TTL or priority of one existing DNS record, addressed by `record_id`.

### Email — 17 tools

- `check_email_deliverability` [R] scopes: read:email — Check whether a domain is set up so its email actually arrives: SPF, DKIM, DMARC and MX, each as pass / fail / could_not_check.
- `create_mailbox` [W] scopes: write:email — Create an email mailbox on a domain the account owns, returning the created address and its quota.
- `delete_mailbox` [D] scopes: delete:hosting + write:email — Permanently delete a mailbox and all of its stored mail.
- `get_email_diagnostics` [R] scopes: read:email — Roll up "why is mail failing" for one owned domain in a single call: it composes the deliverability, mailbox and mail-queue reads and returns `{verdict, summary,…
- `get_email_settings` [R] scopes: read:email — Get the IMAP / POP3 / SMTP settings for a mailbox, ready to paste into a mail client.
- `list_mail_folders` [R] scopes: contents:email + read:email — List one mailbox's folders with message counts, unread counts and sizes — the "do I have new mail / how full is my inbox" answer.
- `list_mailboxes` [R] scopes: read:email — List email mailboxes: per box the address, disk usage in MB, the quota (null = unlimited), whether it is suspended, and the daily send limit.
- `mail_queue` [R] scopes: read:email — Show the mail queue for a customer's server — messages waiting to send and why.
- `manage_autoresponders` [W] scopes: read:email — List, create, update or delete email autoresponders on a domain — the automatic "I received your message" reply set on one mailbox.
- `manage_catch_all` [W] scopes: read:email — Read or set a domain's catch-all — what happens to mail sent to any address on the domain that has no mailbox or forwarder.
- `manage_forwarders` [W] scopes: read:email — List, create or delete email forwarders on a domain — an address that redirects mail to one or more destinations.
- `manage_vacation` [W] scopes: read:email — List, create, update or delete vacation (out-of-office) auto-replies on a domain — like an autoresponder but active only between a start and end date.
- `read_email` [R] scopes: contents:email + read:email — Read one email message in full: subject, sender, recipients, date, the readable body text, and attachment names/sizes (attachment contents are never fetched).
- `resend_invoice_email` [W] scopes: write:billing — Re-send an invoice email to the account's own invoice contacts.
- `set_mailbox_password` [W] scopes: write:email — Change the password of an existing mailbox, returning the address.
- `set_mailbox_quota` [W] scopes: write:email — Change the disk quota of an existing mailbox, returning the address and new quota.
- `trace_email` [R] scopes: read:email — Trace what happened to a customer's mail in the mail-server log: per message the delivery verdict (delivered / bounced / deferred / frozen / queued) with the remote…

### Databases — 5 tools

- `create_database` [W] scopes: write:database — Create a MySQL database and its first user on an account, returning the full prefixed database and user names.
- `drop_database` [D] scopes: delete:hosting + write:database — Permanently drop a MySQL database and every table in it.
- `list_databases` [R] scopes: read:database — List the MySQL databases on an account: each database name (always the full prefixed `username_db`), its assigned users, and size and table count where the node…
- `manage_db_users` [D] scopes: write:database — Create or delete a MySQL database user on a hosting account.
- `set_database_user_password` [W] scopes: write:database — Change a MySQL database user's password, returning the user and the database it belongs to.

### File manager — 9 tools

- `archive_files` [W] scopes: write:files — Compress a path into an archive, or extract an archive, in a hosting account.
- `delete_files` [D] scopes: write:files — Delete a file or directory in a hosting account — irreversible, and deleting a directory removes everything under it.
- `find_files` [R] scopes: read:hosting — Find the largest files or the most recently modified files under a hosting account, or search by name — `kind=largest` (by size, `min_size_mb` default 1) or `recent`…
- `get_profile` [R] scopes: read:account — Read this account's contact profile: `name`, `company`, `country`, `phoneNumber`, `locale`, the read-only `email`, and the `hasTwoFactor` / `hasPostalInvoice` flags.
- `list_files` [R] scopes: read:files — List the files and directories in one folder of a hosting account.
- `manage_files` [W] scopes: write:files — Write, create, copy, move or re-permission a file or directory in a hosting account.
- `read_file` [R] scopes: read:files — Read one text file from a hosting account and return its content.
- `set_directory_password` [W] scopes: write:hosting — Password-protect a directory with an HTTP basic-auth (browser) prompt — an `.htaccess` / `.htpasswd` login on a folder.
- `update_profile` [W] scopes: write:account — Update this account's contact profile.

### Applications — 20 tools

- `clone_wordpress` [W] scopes: write:hosting — Clone a WordPress install to a new location on the same account.
- `create_wordpress_admin_link` [W] scopes: read:hosting + sso:hosting — Mint a one-time wp-admin login URL for a WordPress install, to hand to the human so they can manage the site in wp-admin.
- `get_litespeed_cache_status` [R] scopes: read:hosting — Report the LiteSpeed cache state for a domain — whether the node runs LiteSpeed, whether the domain has a WordPress install with the LiteSpeed Cache plugin, and…
- `get_wordpress_install` [R] scopes: read:hosting — Get the detail for one WordPress install — its version and any pending upgrade, the auto-update state, and the plugins and themes Installatron tracks.
- `import_wordpress` [W] scopes: write:hosting — Bring an existing site under Installatron management.
- `install_wordpress` [W] scopes: write:hosting — Install WordPress on a domain on the account through Installatron.
- `list_apps` [R] scopes: read:hosting — List the web applications Installatron manages on a hosting account — each with its `id`, `application` (e.g.
- `list_wordpress_installs` [R] scopes: read:hosting — List the WordPress installs Installatron manages on a hosting account — each with its `id`, `domain`, `path`, `version`, live `url` and auto-update flag.
- `manage_app` [D] scopes: read:hosting — Read, install, update, back up, log in to, configure or uninstall one Installatron application.
- `manage_wordpress_staging` [D] scopes: write:hosting — Manage a WordPress staging copy.
- `manage_wp_content` [W] scopes: read:hosting — List, read, create, update or trash the pages and posts of one WordPress site over WP-CLI.
- `manage_wp_plugins` [D] scopes: read:hosting — List, install, update, activate, deactivate or uninstall the plugins of one WordPress site over WP-CLI.
- `manage_wp_settings` [W] scopes: read:hosting — Read or change a WordPress site's settings (wp_options) over WP-CLI.
- `manage_wp_site` [D] scopes: read:hosting — Get a WordPress site's status or run a site-wide maintenance action over WP-CLI.
- `manage_wp_themes` [D] scopes: read:hosting — List, install, activate, update or delete the themes of one WordPress site over WP-CLI.
- `manage_wp_users` [W] scopes: read:hosting — List the users of one WordPress site, create a user, or change a user's role over WP-CLI.
- `purge_litespeed_cache` [W] scopes: write:hosting — Purge the LiteSpeed page cache for a domain through the site's own LiteSpeed Cache plugin.
- `query_wp_database` [R] scopes: read:database + read:hosting — Run one read-only SQL statement against a WordPress site's own database and return the rows.
- `reset_wp_admin_password` [D] scopes: write:hosting — Reset the WordPress administrator password for a site and return the new password once.
- `restore_wordpress` [D] scopes: restore:hosting + write:hosting — Restore an Installatron backup over an existing WordPress install.

### Security — 3 tools

- `get_login_history` [R] scopes: read:hosting — List a hosting account's recent authentication events — `events[]`, each `{time, ip, outcome}` (succeeded/failed).
- `get_security_overview` [R] scopes: read:hosting — Report a hosting account's security posture at a glance: `security` — `{csf, imunify360, modsecurity, suspended}` booleans for the host firewall, malware protection,…
- `manage_imunify` [W] scopes: read:hosting — Read or act on Imunify360 malware protection for a hosting account.

### SSL, backups, cron & logs — 14 tools

- `cancel_restore` [D] scopes: restore:hosting + write:hosting — Stop a backup restore that is still pending or running.
- `get_backup_contents` [R] scopes: read:hosting — Show what is inside one backup — which databases, which mailboxes, which DNS zones and certificates, and the home directory's files.
- `get_restore_status` [R] scopes: read:hosting — Check how a backup restore is going, or why it did not finish.
- `get_site_stats` [R] scopes: read:hosting — Report site statistics from the node's own logs and process table.
- `get_ssl_status` [R] scopes: read:hosting — Report the ssl/tls certificate state for a domain: the issuer, the validity window (`validFrom`/`validTo`), `daysRemaining`, whether it has `expired`, whether it is…
- `list_app_backups` [R] scopes: read:hosting — List the Installatron application backups on an account — per backup the `id`, which install it belongs to (`appId`), app, title, version, when it was taken, filename…
- `list_backups` [R] scopes: read:hosting — List the backups a hosting account can be restored from, newest first.
- `manage_cron_jobs` [W] scopes: read:hosting — List, create, update or delete the cron jobs on a hosting account.
- `manage_monitors` [W] scopes: read:hosting — List, create, or delete the account's website uptime monitors, or read one monitor's up/down history.
- `manage_ssl` [D] scopes: write:hosting — Manage a domain's ssl/tls configuration — one tool, several actions.
- `read_logs` [R] scopes: read:hosting — Read the tail of a website `error` log, `access` log, or `email` log for an account, newest lines last, with an optional `contains` substring filter.
- `request_ssl_certificate` [W] scopes: write:hosting — Issue (or reissue) a free Let's Encrypt certificate for a domain, optionally including the `www` and `mail` hostnames.
- `restore_backup` [D] scopes: restore:hosting + write:hosting — Restore a backup over the live hosting account — the whole account, or only the parts you name.
- `restore_domain` [D] scopes: write:billing + write:domains — Restore an expired domain from the registry redemption / pending-delete period.

### VPS — 9 tools

- `get_vps` [R] scopes: read:vps — Get one VPS in full — its power `state` and `online` flag, `vcpu` count, `maxMemory` and `usedMemory`, attached `disks[]`, plus its `node`, `ip` and `status`.
- `get_vps_console` [R] scopes: console:vps — Get the vnc console for a VPS the account owns — its `host`, `port` and a one-time `password` for a vnc client.
- `get_vps_iso` [R] scopes: read:vps — Report the install media on a VPS: which ISO is attached as the boot CD-rom right now (`mounted`, or null) and the ISOs the node offers (`isos[]`).
- `list_vps` [R] scopes: read:vps — List the VPS (virtual private server) services on this account — each with its `serviceId`, `displayName`, `status`, `node`, `ip`, `expiresAt` and, where the client…
- `list_vps_templates` [R] scopes: read:vps — List the OS templates Inleed offers for a VPS — `{id, name, operativeSystem}` each, e.g.
- `reboot_vps` [W] scopes: power:vps — Reboot a VPS the account owns — a graceful guest-OS restart.
- `reset_vps_root_password` [D] scopes: write:vps — Reset the root password of a VPS the account owns — rewritten into the guest image offline, which forces downtime (a stop/start) — and does not reset on this call: it…
- `start_vps` [W] scopes: power:vps — Boot a VPS the account owns, and return `{started, target}`.
- `stop_vps` [D] scopes: power:vps — Force-stop a VPS the account owns — a hard power-off (`virsh destroy`), not a clean shutdown — and does not stop it on this call: it confirms ownership, then returns…

### Domains — 26 tools

- `book_snapback_domain` [C] scopes: write:billing + write:domains — Book a Snapback attempt on a dropping domain, so Inleed tries to register it the instant it is released.
- `check_domain_availability` [R] scopes: read:domains — Check whether any domain can be registered: returns `status` (`available` / `taken` / `unknown`) plus the register and renewal price for its TLD.
- `create_domain_pointer` [W] scopes: write:hosting — Point a second domain at a domain on the account — an `alias` (default; shares the same site and DNS zone) or a `pointer` (parked).
- `create_subdomain` [W] scopes: write:hosting — Create a subdomain on a domain, then confirm it by reading the list back.
- `delete_addon_domain` [D] scopes: delete:hosting + write:hosting — Delete an addon domain from a hosting account.
- `delete_domain_pointer` [D] scopes: write:hosting — Remove a domain pointer (an alias or parked domain) from a domain.
- `delete_subdomain` [D] scopes: delete:hosting + write:hosting — Delete a subdomain.
- `get_domain` [R] scopes: read:domains — Get one registrar domain in detail, enriched with a live registry read: status, expiry, auto-renewal, TLD, the registrar, `nameservers`, DNSSEC `dsRecords`, the…
- `get_domain_auth_code` [R] scopes: transfer:domains — Retrieve a domain's EPP auth code (authInfo / transfer authorization code), returned as `authToken`.
- `get_domain_lifecycle` [R] scopes: read:domains — Read where an owned domain sits in the registry lifecycle: `status`, the derived `flags` (`inRedemption`, `pendingDelete`, `transferProhibited`, `onHold`, `ok`), the…
- `get_snapback_eligibility` [R] scopes: read:domains — Check what stands between this account and a Snapback booking, in one read.
- `list_domain_pointers` [R] scopes: read:hosting — List domain pointers — each as `{domain, type, pointsTo}`, where `type` is `alias` (shares the site and DNS zone) or `pointer` (parked).
- `list_domains` [R] scopes: read:domains — List the registrar domains on the account — each with its id, domain, TLD, status, expiry, auto-renewal, renewal price and per-domain `can:{}` eligibility —…
- `list_snapback_bookings` [R] scopes: read:domains — List the Snapback bookings on this account and how each one turned out.
- `list_snapback_domains` [R] scopes: read:domains — Search the Snapback drop list: `.se` and `.nu` domains about to expire, which Inleed will try to register the instant they are released.
- `list_subdomains` [R] scopes: read:hosting — List subdomains — each as `{label, full}`, e.g.
- `manage_addon_domains` [W] scopes: read:hosting — List, create or update the additional (addon) domains hosted inside a DirectAdmin account.
- `manage_domain_contacts` [D] scopes: write:domains — Read or change the registrar contacts of an owned domain — one tool, several actions.
- `manage_domain_transfers` [D] scopes: transfer:domains — Track and drive inbound domain transfers — one tool, several actions.
- `register_domain` [W] scopes: write:billing + write:domains — Register a new, available domain.
- `renew_domain` [W] scopes: write:billing + write:domains — Renew a domain you own for one or more years.
- `set_domain_autorenew` [W] scopes: write:billing — Turn automatic renewal on or off for a registered domain.
- `set_domain_lock` [W] scopes: write:domains — Set or clear a domain's registrar transfer lock (the lock that blocks an outbound transfer).
- `transfer_domain_in` [W] scopes: transfer:domains + write:billing + write:domains — Transfer a domain you own elsewhere IN to Inleed, using its EPP auth code.
- `update_registrant` [W] scopes: write:domains — Update the registrant contact on a domain in place — name, company, email, phone and address.
- `whois_lookup` [R] scopes: read:domains — Look up any domain in the live public WHOIS: registrar, creation/expiry dates, transfer lock, EPP statuses, nameservers, abuse contact and DNSSEC state.

### Broadband — 2 tools

- `get_broadband_offers` [R] scopes: read:orders — Get every fiber broadband speed and price available at one address.
- `search_broadband_addresses` [R] scopes: read:orders — Check whether Inleed can deliver fiber broadband to a Swedish street address.

### Diagnostics — 5 tools

- `check_disk_usage` [R] scopes: read:hosting — Report the largest directories under an account's home, largest first, as `directories[{path, sizeMb, sizeGb}]` (`unit: MB`; every directory of 1 MB and up, at most…
- `check_ip_blocked` [R] scopes: read:hosting — Check whether one specific IP address is blocked by the node's firewalls — CSF, Imunify360, or the DirectAdmin brute-force blacklist — and why.
- `get_diagnostics_overview` [R] scopes: read:account — Return an account-health summary: what is wrong or about to go wrong at the billing/account level.
- `get_website_diagnostics` [R] scopes: read:hosting — Roll up "why is this site broken" for one owned site in a single call: it composes the hosting, PHP, web-server and SSL reads and returns `{verdict, summary,…
- `whitelist_ip` [W] scopes: write:hosting — Unblock one IP address on the account's node: CSF allow, Imunify360 whitelist where present, and removal from the DirectAdmin blacklist.

### Support & migrations — 4 tools

- `create_support_request` [W] scopes: write:support — Email Inleed support on the customer's behalf.
- `get_onboarding_next_steps` [R] scopes: read:account — Return the account setup checklist and what is left to do — the onboarding steps: add a billing address, set up automatic payment, have an active service, settle…
- `list_support_articles` [R] scopes: read:support — Search the Inleed help centre and read an article.
- `request_migration` [W] scopes: write:hosting — Ask Inleed to migrate a website, email, or control panel into your account.