Hosting

See the services of the account and manage a hosting account through the API: usage, domains, databases, cron, SSL, PHP, backups and FTP.

See the operationsPlayground
On this page
  1. Documentation
    2.  » 
  2. Hosting
Updated on 8 min read
View as Markdown

The API reads the services of your account and manages the active hosting accounts: everything always runs in the account of that service. What is not here yet is done in Meu Interweb.

What you need

A key with hosting:read to read and hosting:write to change. These have their own permission, off by default: hosting:login for the cPanel login, and hosting:code to create cron jobs, create FTP accounts and change their passwords, because all of that can run code on the account. See Permissions. With a sandbox_ key, or while the API is being prepared, changes are simulated: the API checks the request and does not reach the server, so whatever depends on the server, such as whether something already exists, is only checked in Production. See Sandbox and Production.

The list of services

GET /v1/services returns all the services of the account, the newest first: hosting, servers and other products. You can filter with status, for example ?status=active. The list comes in pages.

curl

curl "https://api.interweb.ao/v1/services" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

The details of a service

GET /v1/services/{id} returns the product, address, status, billing cycle, amount and next due date. It never returns passwords.

While a service is unpaid, the domain and username fields may come as null.

When it answers 409

The operations below only run on an active hosting account, on a supported server. Otherwise they answer 409, with the reason in details.reason: not_hosting, service_not_active, server_not_supported or service_not_ready. A service of another account answers 404.

Usage and panel login

GET /v1/services/{id}/usage returns disk, traffic and the resources of the plan.

POST /v1/services/{id}/cpanel-login creates a login link to cPanel. It works once and gives full access to the panel, so use it right away and keep it out of your logs.

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Domains and redirects

Folders are always relative to the account folder, such as public_html/blog. .. and system folders are not accepted. To delete, the name is needed in confirm.

An addon domain, or the root of a subdomain, must be active in your account: registered with us (or a subdomain of one that is), or the domain of an active hosting service. Otherwise the answer is 409 with domain_not_owned. A domain registered elsewhere is added in cPanel.

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}),
});
console.log(response.status);
console.log(await response.text());

Databases

The account prefix is added to the name if missing. In the other operations, use the full name. Passwords have 12 to 128 characters, with at least 3 kinds among lowercase, uppercase, digits and symbols, and never come back in answers.

Cron jobs

GET /v1/services/{id}/cron lists the jobs, with hosting:read, and DELETE /v1/services/{id}/cron/{cron_id} deletes one, with hosting:write.

The command of a job can contain passwords. So command is only filled in with hosting:code. Without it, it is null and command_hidden is true.

POST /v1/services/{id}/cron creates a job and needs hosting:code. Free commands are not accepted: give either php_script, a PHP file of the account, or url, a public address that is called. Addresses must use a domain name that resolves to public addresses, never an IP or an internal name, and cannot have spaces, quotes or %. The minimum interval is 5 minutes and each account has up to 20 jobs. For other commands, use the panel.

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}),
});
console.log(response.status);
console.log(await response.text());

SSL and PHP

Backups

GET /v1/services/{id}/backups lists the dates with a backup on the server. POST /v1/services/{id}/backups requests a full backup, once a day. That file stays in the account folder, takes up space of the plan and is not in the list of dates. Restoring is not done through the API.

FTP

GET /v1/services/{id}/ftp-accounts, POST /v1/services/{id}/ftp-accounts, PUT /v1/services/{id}/ftp-accounts/{login}/password and DELETE /v1/services/{id}/ftp-accounts/{login} manage the logins, always as name@domain. Reading needs hosting:read and deleting hosting:write; creating a login or changing its password needs hosting:code. The main account cannot be changed here.

Limits

Changes have a limit of 20 per minute, per hosting account, and panel login 5 per minute, on top of the general limit. sandbox_ keys have these limits separately, so tests do not use up the Production ones. If the server does not respond as expected, the answer is 502. If the request had already gone to the server, the same Idempotency-Key returns that 502 without running it again, because the change may have been made: check the result and, to try again, use another key. For requests with a password and for panel login, the Idempotency-Key is not kept.

Not available yet

Changing the PHP version, files, Git, Node.js and restoring backups are done in the panel or with support.

Operations

36 operations in this area. Click an operation to see its parameters, examples and responses, or to try it in the Playground, without leaving the page.

GET

List the services

/v1/services
GEThttps://api.interweb.ao/v1/services

Needs hosting:read. All the services of the account, the newest first. While a service is unpaid, domain and username may come as null.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
statusquerystring: pending, active, suspended, terminated, cancelled, fraud, completednoOnly results in this status.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List the services.

{
  "data": [
    {
      "id": 88,
      "product": {
        "id": 12,
        "name": "Plano Empresas",
        "group": "Hospedagem",
        "type": "hostingaccount"
      },
      "domain": "example.co.mz",
      "username": "exemplo88",
      "dedicated_ip": null,
      "status": "active",
      "suspension_reason": null,
      "billing_cycle": "annually",
      "amount": 3600.0,
      "currency": "AOA",
      "payment_method": "M-Pesa",
      "registered_at": "2026-02-01",
      "next_due_date": "2027-02-01",
      "terminated_at": null
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See a service

/v1/services/{id}
GEThttps://api.interweb.ao/v1/services/{id}

Needs hosting:read. Never returns passwords.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See a service.

{
  "data": {
    "id": 88,
    "product": {
      "id": 12,
      "name": "Plano Empresas",
      "group": "Hospedagem",
      "type": "hostingaccount"
    },
    "domain": "example.co.mz",
    "username": "exemplo88",
    "dedicated_ip": null,
    "status": "active",
    "suspension_reason": null,
    "billing_cycle": "annually",
    "amount": 3600.0,
    "currency": "AOA",
    "payment_method": "M-Pesa",
    "registered_at": "2026-02-01",
    "next_due_date": "2027-02-01",
    "terminated_at": null
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See disk, traffic and resource usage

/v1/services/{id}/usage
GEThttps://api.interweb.ao/v1/services/{id}/usage

Needs hosting:read. Disk and traffic in bytes. limit_bytes is null when there is no limit. The items in resources depend on the server. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/usage" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/usage');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/usage", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/usage", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See disk, traffic and resource usage.

{
  "data": {
    "disk": {
      "used_bytes": 1048576,
      "limit_bytes": 10737418240
    },
    "bandwidth": {
      "used_bytes": 5242880,
      "limit_bytes": null
    },
    "resources": [
      {
        "id": "email_accounts",
        "used": 2,
        "limit": null
      }
    ]
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Create a direct login link

/v1/services/{id}/cpanel-login
POSThttps://api.interweb.ao/v1/services/{id}/cpanel-login

Needs hosting:login. The link works once and gives full access to the panel of this account, so keep it private. It is never stored, so Idempotency-Key is not kept here: each call creates a new link. Limit: 5 per minute. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:login.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.
Idempotency-KeyheaderstringnoA unique identifier for this request, so it can be repeated without duplicating it.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

201

Create a direct login link.

{
  "data": {
    "url": "https://srv.example.com:2083/cpsess0000000000/login/?session=exemplo",
    "single_use": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List subdomains

/v1/services/{id}/subdomains
GEThttps://api.interweb.ao/v1/services/{id}/subdomains

Needs hosting:read. Each one with its folder, relative to the account folder. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List subdomains.

{
  "data": [
    {
      "domain": "blog.example.co.mz",
      "root_domain": "example.co.mz",
      "directory": "public_html/blog"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Create a subdomain

/v1/services/{id}/subdomains
POSThttps://api.interweb.ao/v1/services/{id}/subdomains

Needs hosting:write. The root_domain must be active in your account: registered with us (or a subdomain of one that is), or the domain of an active hosting service, otherwise it answers 409 with domain_not_owned. A domain registered elsewhere is added in cPanel. The root_domain must be a domain of this hosting account. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
Idempotency-KeyheaderstringnoAny unique value, up to 255 visible characters. Valid for 24 hours per key. Repeating the same request returns the saved answer; a different body, or a first request still in progress, returns 409.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
root_domainstringyesA domain of this hosting account.
namestringyesThe name before the domain.
directorystringnoFolder relative to the account folder, without .. and outside system folders.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}),
});
console.log(response.status);
console.log(await response.text());

Responses

201

Create a subdomain.

{
  "data": {
    "domain": "blog.example.co.mz",
    "root_domain": "example.co.mz",
    "directory": "public_html/blog",
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

DELETE

Delete a subdomain

/v1/services/{id}/subdomains/{domain}
DELETEhttps://api.interweb.ao/v1/services/{id}/subdomains/{domain}

Needs hosting:write. Needs the name in confirm. The files stay in the folder. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
domainpathstringyesThe full name of the domain.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
confirmstringyesThe exact name of what you are deleting, to confirm.

Examples

curl

curl -X DELETE "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "blog.example.co.mz"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "blog.example.co.mz"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
payload = {"confirm": "blog.example.co.mz"}
r = requests.delete("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/subdomains/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "blog.example.co.mz"}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Delete a subdomain.

{
  "data": {
    "domain": "blog.example.co.mz",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List addon domains

/v1/services/{id}/addon-domains
GEThttps://api.interweb.ao/v1/services/{id}/addon-domains

Needs hosting:read. The domains with their own site in this account. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List addon domains.

{
  "data": [
    {
      "domain": "outro.co.mz",
      "directory": "public_html/outro.co.mz"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Add an addon domain

/v1/services/{id}/addon-domains
POSThttps://api.interweb.ao/v1/services/{id}/addon-domains

Needs hosting:write. The domain must be active in your account: registered with us (or a subdomain of one that is), or the domain of an active hosting service, otherwise it answers 409 with domain_not_owned. A domain registered elsewhere is added in cPanel. Counts towards the limit of sites of the plan. The domain must point to our nameservers. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
Idempotency-KeyheaderstringnoAny unique value, up to 255 visible characters. Valid for 24 hours per key. Repeating the same request returns the saved answer; a different body, or a first request still in progress, returns 409.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
domainstringyesThe domain to add.
directorystringnoFolder relative to the account folder, without .. and outside system folders.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"domain": "outro.co.mz"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"domain": "outro.co.mz"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"domain": "outro.co.mz"}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"domain": "outro.co.mz"}),
});
console.log(response.status);
console.log(await response.text());

Responses

201

Add an addon domain.

{
  "data": {
    "domain": "outro.co.mz",
    "directory": "public_html/outro.co.mz",
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

DELETE

Remove an addon domain

/v1/services/{id}/addon-domains/{domain}
DELETEhttps://api.interweb.ao/v1/services/{id}/addon-domains/{domain}

Needs hosting:write. Needs the name in confirm. The files stay in the folder. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
domainpathstringyesThe full name of the domain.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
confirmstringyesThe exact name of what you are deleting, to confirm.

Examples

curl

curl -X DELETE "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "outro.co.mz"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "outro.co.mz"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
payload = {"confirm": "outro.co.mz"}
r = requests.delete("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/addon-domains/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "outro.co.mz"}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Remove an addon domain.

{
  "data": {
    "domain": "outro.co.mz",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List redirects

/v1/services/{id}/redirects
GEThttps://api.interweb.ao/v1/services/{id}/redirects

Needs hosting:read. A domain of all applies to every domain of the account. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List redirects.

{
  "data": [
    {
      "id": "3f2a9c1b7d4e8f60",
      "domain": "example.co.mz",
      "source": "/antigo",
      "destination": "https://www.example.co.mz/novo",
      "type": "permanent",
      "wildcard": false
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Create a redirect

/v1/services/{id}/redirects
POSThttps://api.interweb.ao/v1/services/{id}/redirects

Needs hosting:write. The destination starts with http:// or https:// and cannot have spaces, quotes or %. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
Idempotency-KeyheaderstringnoAny unique value, up to 255 visible characters. Valid for 24 hours per key. Repeating the same request returns the saved answer; a different body, or a first request still in progress, returns 409.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
domainstringyesA domain of this hosting account.
sourcestringnoPath starting with /. If omitted, /.
destinationstringyesWhere it goes.
typestringnopermanent or temporary.
wildcardbooleannoKeeps the rest of the path.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.co.mz", "source": "/antigo", "destination": "https://www.example.co.mz/novo"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"domain": "example.co.mz", "source": "/antigo", "destination": "https://www.example.co.mz/novo"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"domain": "example.co.mz", "source": "/antigo", "destination": "https://www.example.co.mz/novo"}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"domain": "example.co.mz", "source": "/antigo", "destination": "https://www.example.co.mz/novo"}),
});
console.log(response.status);
console.log(await response.text());

Responses

201

Create a redirect.

{
  "data": {
    "id": "3f2a9c1b7d4e8f60",
    "domain": "example.co.mz",
    "source": "/antigo",
    "destination": "https://www.example.co.mz/novo",
    "type": "permanent",
    "wildcard": false,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

DELETE

Delete a redirect

/v1/services/{id}/redirects/{redirect_id}
DELETEhttps://api.interweb.ao/v1/services/{id}/redirects/{redirect_id}

Needs hosting:write. Use the id from the list. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
redirect_idpathstringyesThe id from the list.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl -X DELETE "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.delete("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects/VALUE", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/redirects/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

Delete a redirect.

{
  "data": {
    "id": "3f2a9c1b7d4e8f60",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List databases

/v1/services/{id}/databases
GEThttps://api.interweb.ao/v1/services/{id}/databases

Needs hosting:read. Each one with its size and users. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List databases.

{
  "data": [
    {
      "name": "conta_site",
      "disk_usage_bytes": 1048576,
      "users": [
        "conta_site"
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Create a database

/v1/services/{id}/databases
POSThttps://api.interweb.ao/v1/services/{id}/databases

Needs hosting:write. The answer gives the final name, with the prefix. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
Idempotency-KeyheaderstringnoAny unique value, up to 255 visible characters. Valid for 24 hours per key. Repeating the same request returns the saved answer; a different body, or a first request still in progress, returns 409.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
namestringyesLowercase letters, digits and _. The account prefix is added if missing.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"name": "site"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"name": "site"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"name": "site"}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"name": "site"}),
});
console.log(response.status);
console.log(await response.text());

Responses

201

Create a database.

{
  "data": {
    "name": "conta_site",
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

DELETE

Delete a database

/v1/services/{id}/databases/{name}
DELETEhttps://api.interweb.ao/v1/services/{id}/databases/{name}

Needs hosting:write. Needs the name in confirm. The data is lost. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
namepathstringyesThe full name, with the account prefix.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
confirmstringyesThe exact name of what you are deleting, to confirm.

Examples

curl

curl -X DELETE "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "conta_site"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "conta_site"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
payload = {"confirm": "conta_site"}
r = requests.delete("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "conta_site"}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Delete a database.

{
  "data": {
    "name": "conta_site",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List database users

/v1/services/{id}/database-users
GEThttps://api.interweb.ao/v1/services/{id}/database-users

Needs hosting:read. Each one with the databases it can reach. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List database users.

{
  "data": [
    {
      "name": "conta_site",
      "databases": [
        "conta_site"
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Create a database user

/v1/services/{id}/database-users
POSThttps://api.interweb.ao/v1/services/{id}/database-users

Needs hosting:write. The password is never stored by the API, so Idempotency-Key is not kept here. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.
Idempotency-KeyheaderstringnoA unique identifier for this request, so it can be repeated without duplicating it.

Request body

FieldTypeRequiredDescription
namestringyesLowercase letters, digits and _. The account prefix is added if missing.
passwordstringyes12 to 128 characters, with at least 3 kinds among lowercase, uppercase, digits and symbols, without the account name. It never comes back.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"name": "site", "password": "pP7-kX2mQ9vL4tR8wZ3a"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"name": "site", "password": "pP7-kX2mQ9vL4tR8wZ3a"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"name": "site", "password": "pP7-kX2mQ9vL4tR8wZ3a"}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"name": "site", "password": "pP7-kX2mQ9vL4tR8wZ3a"}),
});
console.log(response.status);
console.log(await response.text());

Responses

201

Create a database user.

{
  "data": {
    "name": "conta_site",
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

PUT

Change a database user password

/v1/services/{id}/database-users/{name}/password
PUThttps://api.interweb.ao/v1/services/{id}/database-users/{name}/password

Needs hosting:write. The password never comes back. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
namepathstringyesThe full name, with the account prefix.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
passwordstringyes12 to 128 characters, with at least 3 kinds among lowercase, uppercase, digits and symbols, without the account name. It never comes back.

Examples

curl

curl -X PUT "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE/password" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Content-Type: application/json" \
  -d '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE/password');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
payload = {"password": "pP7-kX2mQ9vL4tR8wZ3a"}
r = requests.put("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE/password", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE/password", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"password": "pP7-kX2mQ9vL4tR8wZ3a"}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Change a database user password.

{
  "data": {
    "name": "conta_site",
    "password_changed": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

DELETE

Delete a database user

/v1/services/{id}/database-users/{name}
DELETEhttps://api.interweb.ao/v1/services/{id}/database-users/{name}

Needs hosting:write. Needs the name in confirm. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
namepathstringyesThe full name, with the account prefix.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
confirmstringyesThe exact name of what you are deleting, to confirm.

Examples

curl

curl -X DELETE "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "conta_site"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "conta_site"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
payload = {"confirm": "conta_site"}
r = requests.delete("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "conta_site"}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Delete a database user.

{
  "data": {
    "name": "conta_site",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

PUT

Give a user access to a database

/v1/services/{id}/databases/{name}/users/{user}
PUThttps://api.interweb.ao/v1/services/{id}/databases/{name}/users/{user}

Needs hosting:write. Use ALL, or a list such as SELECT and INSERT. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
namepathstringyesThe full name, with the account prefix.
userpathstringyesThe full name of the user, with the account prefix.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
privilegesarray<string>noIf omitted, ALL.

Examples

curl

curl -X PUT "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Content-Type: application/json" \
  -d '{"privileges": ["ALL"]}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"privileges": ["ALL"]}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
payload = {"privileges": ["ALL"]}
r = requests.put("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"privileges": ["ALL"]}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Give a user access to a database.

{
  "data": {
    "database": "conta_site",
    "user": "conta_site",
    "privileges": [
      "ALL"
    ],
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

DELETE

Remove a user access to a database

/v1/services/{id}/databases/{name}/users/{user}
DELETEhttps://api.interweb.ao/v1/services/{id}/databases/{name}/users/{user}

Needs hosting:write. The user and the database stay. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
namepathstringyesThe full name, with the account prefix.
userpathstringyesThe full name of the user, with the account prefix.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl -X DELETE "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.delete("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

Remove a user access to a database.

{
  "data": {
    "database": "conta_site",
    "user": "conta_site",
    "revoked": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List cron jobs

/v1/services/{id}/cron
GEThttps://api.interweb.ao/v1/services/{id}/cron

Needs hosting:read. Includes the jobs created in the panel. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason. command can contain passwords: it is only filled in with hosting:code; without it, it is null and command_hidden is true.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List cron jobs.

{
  "data": [
    {
      "id": "a1b2c3d4",
      "schedule": "*/15 * * * *",
      "command": null,
      "command_hidden": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Create a cron job

/v1/services/{id}/cron
POSThttps://api.interweb.ao/v1/services/{id}/cron

Needs hosting:code. A cron job runs code on the account, so this permission is separate from hosting:write and off by default. In url, only public domain names that resolve to public addresses are accepted. Free commands are not accepted: give either php_script, a PHP file of the account, or url, a public address that is called. The minimum interval is 5 minutes and each account has up to 20 jobs. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:code.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
Idempotency-KeyheaderstringnoAny unique value, up to 255 visible characters. Valid for 24 hours per key. Repeating the same request returns the saved answer; a different body, or a first request still in progress, returns 409.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
schedulestringyesFive fields, with digits and *, ,, /, -.
php_scriptstringnoA PHP file, relative to the account folder.
urlstringnoA public http:// or https:// address, without %.
argsarray<string>noUp to 8 values for the script.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}),
});
console.log(response.status);
console.log(await response.text());

Responses

201

Create a cron job.

{
  "data": {
    "id": "a1b2c3d4",
    "schedule": "*/15 * * * *",
    "command": "/usr/local/bin/php -q public_html/cron.php >/dev/null 2>&1",
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

DELETE

Delete a cron job

/v1/services/{id}/cron/{cron_id}
DELETEhttps://api.interweb.ao/v1/services/{id}/cron/{cron_id}

Needs hosting:write. Use the id from the list. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
cron_idpathstringyesThe id from the list.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl -X DELETE "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.delete("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron/VALUE", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/cron/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

Delete a cron job.

{
  "data": {
    "id": "a1b2c3d4",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See the SSL certificates

/v1/services/{id}/ssl
GEThttps://api.interweb.ao/v1/services/{id}/ssl

Needs hosting:read. The certificate of each site and its expiry date. meta.autossl_running says if a free certificate is being requested. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ssl" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ssl');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ssl", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ssl", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See the SSL certificates.

{
  "data": [
    {
      "domain": "example.co.mz",
      "domains": [
        "example.co.mz",
        "www.example.co.mz"
      ],
      "expires_at": "2027-02-01T10:00:00+02:00",
      "self_signed": false,
      "validation_type": "dv"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1,
    "autossl_running": false
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Request free certificates

/v1/services/{id}/ssl/autossl
POSThttps://api.interweb.ao/v1/services/{id}/ssl/autossl

Needs hosting:write. It only works for domains that point to our servers. Limit: once every 15 minutes per account. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
Idempotency-KeyheaderstringnoAny unique value, up to 255 visible characters. Valid for 24 hours per key. Repeating the same request returns the saved answer; a different body, or a first request still in progress, returns 409.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ssl/autossl" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ssl/autossl');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ssl/autossl", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ssl/autossl", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

202

Request free certificates.

{
  "data": {
    "requested": true,
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See the PHP version of each site

/v1/services/{id}/php
GEThttps://api.interweb.ao/v1/services/{id}/php

Needs hosting:read. The version of each domain, or inherit. To change the version, use the panel. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See the PHP version of each site.

{
  "data": [
    {
      "domain": "example.co.mz",
      "version": "8.2"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1,
    "available_versions": [
      "7.4",
      "8.2"
    ]
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

See the PHP options

/v1/services/{id}/php/options
GEThttps://api.interweb.ao/v1/services/{id}/php/options

Needs hosting:read. Only the options that can be changed through the API. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
domainquerystringnoA domain of this hosting account. If omitted, the main domain.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php/options" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php/options');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php/options", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php/options", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

See the PHP options.

{
  "data": {
    "domain": "example.co.mz",
    "options": {
      "memory_limit": "256M",
      "max_execution_time": "60"
    }
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

PUT

Change the PHP options

/v1/services/{id}/php/options
PUThttps://api.interweb.ao/v1/services/{id}/php/options

Needs hosting:write. Accepted: memory_limit (32M to 2048M), post_max_size and upload_max_filesize (1M to 2048M), max_execution_time and max_input_time (1 to 600), max_input_vars (100 to 20000), session.gc_maxlifetime (60 to 86400), display_errors and zlib.output_compression (true or false). With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
domainstringyesA domain of this hosting account.
optionsobjectyesThe options to change.

Examples

curl

curl -X PUT "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php/options" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.co.mz", "options": {"memory_limit": "256M", "max_execution_time": 60}}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php/options');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"domain": "example.co.mz", "options": {"memory_limit": "256M", "max_execution_time": 60}}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
payload = {"domain": "example.co.mz", "options": {"memory_limit": "256M", "max_execution_time": 60}}
r = requests.put("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php/options", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/php/options", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"domain": "example.co.mz", "options": {"memory_limit": "256M", "max_execution_time": 60}}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Change the PHP options.

{
  "data": {
    "domain": "example.co.mz",
    "options": {
      "memory_limit": "256M"
    },
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List backup dates

/v1/services/{id}/backups
GEThttps://api.interweb.ao/v1/services/{id}/backups

Needs hosting:read. The dates with a backup on the server. The backup requested with POST stays in the account folder and is not in this list. To restore, use the portal or ask support. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/backups" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/backups');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/backups", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/backups", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List backup dates.

{
  "data": [
    {
      "date": "2026-11-01"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Request a full backup

/v1/services/{id}/backups
POSThttps://api.interweb.ao/v1/services/{id}/backups

Needs hosting:write. The file stays in the account folder and takes up space of the plan. Limit: once a day per account. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
Idempotency-KeyheaderstringnoAny unique value, up to 255 visible characters. Valid for 24 hours per key. Repeating the same request returns the saved answer; a different body, or a first request still in progress, returns 409.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/backups" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/backups');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/backups", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/backups", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

202

Request a full backup.

{
  "data": {
    "requested": true,
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

GET

List FTP accounts

/v1/services/{id}/ftp-accounts
GEThttps://api.interweb.ao/v1/services/{id}/ftp-accounts

Needs hosting:read. quota_mb is null when there is no limit. If the service is not active, or is not a supported hosting account, it answers 409 with the reason in details.reason.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:read.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
pagequeryintegernoThe page number. The first is 1.
per_pagequeryintegernoResults per page, from 1 to 100. The default is 10.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Examples

curl

curl "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en"

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
r = requests.get("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
  },
});
console.log(response.status);
console.log(await response.text());

Responses

200

List FTP accounts.

{
  "data": [
    {
      "login": "[email protected]",
      "type": "sub",
      "directory": "public_html/ana",
      "used_mb": 1.5,
      "quota_mb": 1024
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

POST

Create an FTP account

/v1/services/{id}/ftp-accounts
POSThttps://api.interweb.ao/v1/services/{id}/ftp-accounts

Needs hosting:code. FTP in the site folder can run code on the account, so this permission is separate from hosting:write and off by default. The access only sees its folder. The password is never stored by the API, so Idempotency-Key is not kept here. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:code.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.
Idempotency-KeyheaderstringnoA unique identifier for this request, so it can be repeated without duplicating it.

Request body

FieldTypeRequiredDescription
userstringyesThe name before the domain.
domainstringyesA domain of this hosting account.
passwordstringyes12 to 128 characters, with at least 3 kinds among lowercase, uppercase, digits and symbols, without the account name. It never comes back.
directorystringyesFolder relative to the account folder, without .. and outside system folders.
quota_mbintegernoFrom 1 to 102400. If omitted, 1024.

Examples

curl

curl -X POST "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"user": "ana", "domain": "example.co.mz", "password": "pP7-kX2mQ9vL4tR8wZ3a", "directory": "public_html/ana"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"user": "ana", "domain": "example.co.mz", "password": "pP7-kX2mQ9vL4tR8wZ3a", "directory": "public_html/ana"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"user": "ana", "domain": "example.co.mz", "password": "pP7-kX2mQ9vL4tR8wZ3a", "directory": "public_html/ana"}
r = requests.post("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"user": "ana", "domain": "example.co.mz", "password": "pP7-kX2mQ9vL4tR8wZ3a", "directory": "public_html/ana"}),
});
console.log(response.status);
console.log(await response.text());

Responses

201

Create an FTP account.

{
  "data": {
    "login": "[email protected]",
    "directory": "public_html/ana",
    "quota_mb": 1024,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

PUT

Change an FTP password

/v1/services/{id}/ftp-accounts/{login}/password
PUThttps://api.interweb.ao/v1/services/{id}/ftp-accounts/{login}/password

Needs hosting:code. FTP in the site folder can run code on the account, so this permission is separate from hosting:write and off by default. The main account cannot be changed here. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:code.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
loginpathstringyesThe login, as name@domain.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
passwordstringyes12 to 128 characters, with at least 3 kinds among lowercase, uppercase, digits and symbols, without the account name. It never comes back.

Examples

curl

curl -X PUT "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE/password" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Content-Type: application/json" \
  -d '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE/password');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
payload = {"password": "pP7-kX2mQ9vL4tR8wZ3a"}
r = requests.put("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE/password", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE/password", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"password": "pP7-kX2mQ9vL4tR8wZ3a"}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Change an FTP password.

{
  "data": {
    "login": "[email protected]",
    "password_changed": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.

DELETE

Delete an FTP account

/v1/services/{id}/ftp-accounts/{login}
DELETEhttps://api.interweb.ao/v1/services/{id}/ftp-accounts/{login}

Needs hosting:write. Needs the login in confirm. The files stay. The main account cannot be deleted. With a sandbox_ key it only checks the request and changes nothing.

Authentication

Needs a valid key in the Authorization: Bearer header. Required permission: hosting:write.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe id of the hosting service.
loginpathstringyesThe login, as name@domain.
X-API-Modeheaderstring: sandbox, productionnoOptional. If it does not match the mode of the key, the request is refused with invalid_request and reason mode_mismatch. Use it to make sure a program never runs with the wrong key.

Request body

FieldTypeRequiredDescription
confirmstringyesThe exact name of what you are deleting, to confirm.

Examples

curl

curl -X DELETE "https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: en" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "[email protected]"}'

PHP

<?php
$ch = curl_init('https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "[email protected]"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: en',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "en",
}
payload = {"confirm": "[email protected]"}
r = requests.delete("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.interweb.ao/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "en",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "[email protected]"}),
});
console.log(response.status);
console.log(await response.text());

Responses

200

Delete an FTP account.

{
  "data": {
    "login": "[email protected]",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
HeaderDescription
X-Correlation-IDIdentifier of this request. Give it to support when you report a problem.
X-RateLimit-LimitRequests allowed per minute.
X-RateLimit-RemainingRequests left in the current minute.
X-RateLimit-ResetWhen the minute ends, as a Unix timestamp in seconds.
X-API-ModeThe mode of the key that made the request: sandbox or production.

401

The key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

The account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "This key does not have the required permission.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Not found.

{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

The operation cannot be done in the current state. See details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Some of the data is not valid.

{
  "error": {
    "code": "validation_failed",
    "message": "Some of the data is not valid.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Too many requests. Wait for the time in Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
HeaderDescription
Retry-AfterSeconds to wait before trying again.

500

An internal error occurred. Give the correlation_id to support.

{
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred. Please give the correlation_id to support.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

The service behind the API did not respond as expected.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

The API is turned off.

{
  "error": {
    "code": "disabled",
    "message": "The API is currently turned off.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Errors

StatusCodeMeaning
401unauthorizedThe key is missing, invalid, revoked or expired, or the user who created it no longer has access to the account.
403forbidden, insufficient_scope, ip_not_allowedThe account cannot use the API (forbidden), the key lacks the permission (insufficient_scope), or the IP address is not on the list of the key (ip_not_allowed).
404not_foundNot found.
409conflictThe operation cannot be done in the current state. See details.reason.
422validation_failedSome of the data is not valid.
429rate_limitedToo many requests. Wait for the time in Retry-After.
500internal_errorAn internal error occurred. Give the correlation_id to support.
502upstream_errorThe service behind the API did not respond as expected.
503disabledThe API is turned off.

The error format is explained in Errors.