Dominios personalizados

Recupere los dominios actualmente ativos y disponibles

GET https://xerp.ae/api/domains/available
curl --request GET \
--url 'https://xerp.ae/api/domains/available' \
--header 'Authorization: Bearer {api_key}' \
Parámetros Detalles Descripción
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Por qual campo estás pesquisando. Los valores permitidos son: host.
datetime_field Opcional Cadeia Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre los resultados a partir desta fecha y hora. Formato Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre los resultados hasta esta fecha y hora. Formato Y-m-d H:i:s.
order_by Opcional Cadeia Por qual campo ordenar los resultados. Los valores permitidos son: domain_id, datetime, last_datetime, host.
order_type Opcional Cadeia A ordenação de los resultados. Los valores permitidos son: ASC para ordenação ascendente y DESC para ordenação descendente.
page Opcional Inteiro O número de la página que deseas resultados. O predeterminado es 1.
results_per_page Opcional Inteiro Quantos resultados deseas por página. Los valores permitidos son: 10, 25, 50, 100, 250, 500, 1000. O predeterminado es 25. 
{
    "data": [
        {
            "id": 1,
            "type": 0,
            "scheme": "https://",
            "host": "example.com",
            "custom_index_url": "",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-07-15 20:12:33",
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://xerp.ae/api/domains/available?page=1",
        "last": "https://xerp.ae/api/domains/available?page=1",
        "next": null,
        "prev": null,
        "self": "https://xerp.ae/api/domains/available?page=1"
    }
}

Recuperar todos

GET https://xerp.ae/api/domains/
curl --request GET \
--url 'https://xerp.ae/api/domains/' \
--header 'Authorization: Bearer {api_key}' \
Parámetros Detalles Descripción
search Opcional Cadeia A string de pesquisa.
search_by Opcional Cadeia Por qual campo estás pesquisando. Los valores permitidos son: host.
is_enabled Opcional Boolean
datetime_field Opcional Cadeia Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadeia Filtre los resultados a partir desta fecha y hora. Formato Y-m-d H:i:s.
datetime_end Opcional Cadeia Filtre los resultados hasta esta fecha y hora. Formato Y-m-d H:i:s.
order_by Opcional Cadeia Por qual campo ordenar los resultados. Los valores permitidos son: domain_id, datetime, last_datetime, host.
order_type Opcional Cadeia A ordenação de los resultados. Los valores permitidos son: ASC para ordenação ascendente y DESC para ordenação descendente.
page Opcional Inteiro O número de la página que deseas resultados. O predeterminado es 1.
results_per_page Opcional Inteiro Quantos resultados deseas por página. Los valores permitidos son: 10, 25, 50, 100, 250, 500, 1000. O predeterminado es 25. 
{
    "data": [
        {
            "id": 1,
            "scheme": "https://",
            "host": "example.com",
            "custom_index_url": "",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-07-15 20:12:33",
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://xerp.ae/api/domains?page=1",
        "last": "https://xerp.ae/api/domains?page=1",
        "next": null,
        "prev": null,
        "self": "https://xerp.ae/api/domains?page=1"
    }
}

Recuperar un

GET https://xerp.ae/api/domains/{domain_id}
curl --request GET \
--url 'https://xerp.ae/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "scheme": "https://",
        "host": "example.com",
        "custom_index_url": "",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-07-15 20:12:33",
    }
}

Crear

POST https://xerp.ae/api/domains
Parámetros Detalles Descripción
host Obligatorio Cadeia -
custom_index_url Opcional Cadeia -
custom_not_found_url Opcional Cadeia -
curl --request POST \
--url 'https://xerp.ae/api/domains' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=example.com' \
--form 'custom_index_url=https://example.com/' \
--form 'custom_not_found_url=https://example.com/404-page' 
{
    "data": {
        "id": 1
    }
}

Actualizar

POST https://xerp.ae/api/domains/{domain_id}
Parámetros Detalles Descripción
host Opcional Cadeia -
custom_index_url Opcional Cadeia -
custom_not_found_url Opcional Cadeia -
curl --request POST \
--url 'https://xerp.ae/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=example.com' \
{
    "data": {
        "id": 1
    }
}

Eliminar

DELETE https://xerp.ae/api/domains/{domain_id}
curl --request DELETE \
--url 'https://xerp.ae/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \