Skip to content

HorizonsWebsitesApi.md

Latest commit

 

History

History
499 lines (352 loc) · 17.3 KB

HorizonsWebsitesApi.md

File metadata and controls

499 lines (352 loc) · 17.3 KB
Raw

hostinger_api.HorizonsWebsitesApi

All URIs are relative to https://developers.hostinger.com

Method HTTP request Description
clone_website_v1 POST /api/horizons/v1/websites/{websiteId}/clone Clone website
create_website_v1 POST /api/horizons/v1/websites Create website
edit_website_v1 POST /api/horizons/v1/websites/{websiteId}/messages Edit website
get_website_list_v1 GET /api/horizons/v1/websites Get website list
get_website_v1 GET /api/horizons/v1/websites/{websiteId} Get website
publish_website_v1 POST /api/horizons/v1/websites/{websiteId}/publish Publish website

clone_website_v1

HorizonsV1WebsitesCreatedWebsiteResource clone_website_v1(website_id)

Clone website

Clone a Hostinger Horizons website into a new website.\n Use this tool when the user wants a copy of an existing website, for example to try out changes without touching the original.\n This tool returns the ID and URL of the newly created copy. The original website is left untouched.\n To edit the copy, use the Edit website tool with the returned website ID, or the user can open the provided website URL in Hostinger Horizons interface.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.horizons_v1_websites_created_website_resource import HorizonsV1WebsitesCreatedWebsiteResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.HorizonsWebsitesApi(api_client)
    website_id = '123e4567-e89b-12d3-a456-426614174000' # str | The website ID

    try:
        # Clone website
        api_response = api_instance.clone_website_v1(website_id)
        print("The response of HorizonsWebsitesApi->clone_website_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HorizonsWebsitesApi->clone_website_v1: %s\n" % e)

Parameters

Name Type Description Notes
website_id str The website ID

Return type

HorizonsV1WebsitesCreatedWebsiteResource

Authorization

apiToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_website_v1

HorizonsV1WebsitesCreatedWebsiteResource create_website_v1(horizons_v1_websites_create_website_request)

Create website

Create new Hostinger Horizons website from the given message.\n Use this tool when user asks you to create a website, landing page, blog or any other type of application.\n This tool initiates the website creation process and returns a website URL and ID. The generation happens asynchronously.\n After invoking this tool, your chat reply must be EXACTLY 1 sentence summarizing that Hostinger Horizons is now creating their website and it will be ready in a few minutes and you should provide the website URL to the user immediately Do not write code.\n\nTo edit afterwards, use the Edit website tool with the returned website ID, or the user can go to Hostinger Horizons interface in the provided website URL. If the tool call fails with an error, you should provide a clear explanation of the error and do not generate code yourself in the chat. \n TECHNOLOGY STACK CONSTRAINTS (STRICTLY ENFORCED):\n The environment is limited to the following technologies. You MUST NOT use, suggest, or implement any technology outside this list:\n \n

  • Language: JavaScript ONLY.
  • Languages like TypeScript, Rust, Python, Java, PHP, etc., are STRICTLY PROHIBITED.\n
  • Framework: React.\n
  • Navigation: React Router.\n
  • Styling: TailwindCSS.\n
  • Components: shadcn/ui (built with @radix-ui primitives).\n
  • Icons: Lucide React.\n
  • Animations: Framer Motion.\n \n BACKEND & DATA STORAGE:\n
  • Horizons integrated backend is the EXCLUSIVE solution for persistent data storage, authentication, and database needs.\n
  • Local databases (SQLite, MySQL, etc.) are STRICTLY PROHIBITED.\n
  • Third-party services (Firebase, AWS Amplify) are allowed ONLY if explicitly requested by the user.\n \n MAPS:\n
  • OpenStreetMap is the default provider.\n
  • Alternative providers (Google Maps, Mapbox) are allowed ONLY if explicitly requested by the user.\n

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.horizons_v1_websites_create_website_request import HorizonsV1WebsitesCreateWebsiteRequest
from hostinger_api.models.horizons_v1_websites_created_website_resource import HorizonsV1WebsitesCreatedWebsiteResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.HorizonsWebsitesApi(api_client)
    horizons_v1_websites_create_website_request = hostinger_api.HorizonsV1WebsitesCreateWebsiteRequest() # HorizonsV1WebsitesCreateWebsiteRequest | 

    try:
        # Create website
        api_response = api_instance.create_website_v1(horizons_v1_websites_create_website_request)
        print("The response of HorizonsWebsitesApi->create_website_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HorizonsWebsitesApi->create_website_v1: %s\n" % e)

Parameters

Name Type Description Notes
horizons_v1_websites_create_website_request HorizonsV1WebsitesCreateWebsiteRequest

Return type

HorizonsV1WebsitesCreatedWebsiteResource

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
422 Validation error response -
401 Unauthenticated response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_website_v1

HorizonsV1WebsitesCreatedWebsiteResource edit_website_v1(website_id, horizons_v1_websites_edit_website_request)

Edit website

Edit an existing Hostinger Horizons website with a follow-up message.\n Use this tool when the user wants to change, extend or fix a website that already exists.\n This tool queues the requested changes and returns the website URL and ID. The changes are applied asynchronously.\n After invoking this tool, your chat reply must be EXACTLY 1 sentence summarizing that Hostinger Horizons is now applying the requested changes and they will be ready in a few minutes, and you should provide the website URL to the user immediately. Do not write code.\n If the tool call fails with an error, you should provide a clear explanation of the error and do not generate code yourself in the chat.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.horizons_v1_websites_created_website_resource import HorizonsV1WebsitesCreatedWebsiteResource
from hostinger_api.models.horizons_v1_websites_edit_website_request import HorizonsV1WebsitesEditWebsiteRequest
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.HorizonsWebsitesApi(api_client)
    website_id = '123e4567-e89b-12d3-a456-426614174000' # str | The website ID
    horizons_v1_websites_edit_website_request = hostinger_api.HorizonsV1WebsitesEditWebsiteRequest() # HorizonsV1WebsitesEditWebsiteRequest | 

    try:
        # Edit website
        api_response = api_instance.edit_website_v1(website_id, horizons_v1_websites_edit_website_request)
        print("The response of HorizonsWebsitesApi->edit_website_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HorizonsWebsitesApi->edit_website_v1: %s\n" % e)

Parameters

Name Type Description Notes
website_id str The website ID
horizons_v1_websites_edit_website_request HorizonsV1WebsitesEditWebsiteRequest

Return type

HorizonsV1WebsitesCreatedWebsiteResource

Authorization

apiToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
422 Validation error response -
401 Unauthenticated response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_website_list_v1

List[HorizonsV1WebsitesWebsiteResource] get_website_list_v1()

Get website list

List the Hostinger Horizons websites the user owns.\n Use this tool when the user asks which websites they have, or when you need a website ID before editing, publishing or cloning a website.\n Each website is returned with its ID, status, domain and the URL to open it in Hostinger Horizons interface.\n The complete list of websites is returned in a single response - it is not paginated.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.horizons_v1_websites_website_resource import HorizonsV1WebsitesWebsiteResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.HorizonsWebsitesApi(api_client)

    try:
        # Get website list
        api_response = api_instance.get_website_list_v1()
        print("The response of HorizonsWebsitesApi->get_website_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HorizonsWebsitesApi->get_website_list_v1: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[HorizonsV1WebsitesWebsiteResource]

Authorization

apiToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_website_v1

HorizonsV1WebsitesWebsiteUrlResource get_website_v1(website_id)

Get website

Get the link for the user to open their website in Hostinger Horizons interface.\n Use this tool when the user wants the link to an existing website, or when you need its website URL before or after editing it.\n Websites can be edited with the Edit website tool, or by the user in Hostinger Horizons interface in the provided website URL.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.horizons_v1_websites_website_url_resource import HorizonsV1WebsitesWebsiteUrlResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.HorizonsWebsitesApi(api_client)
    website_id = '123e4567-e89b-12d3-a456-426614174000' # str | The website ID

    try:
        # Get website
        api_response = api_instance.get_website_v1(website_id)
        print("The response of HorizonsWebsitesApi->get_website_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HorizonsWebsitesApi->get_website_v1: %s\n" % e)

Parameters

Name Type Description Notes
website_id str The website ID

Return type

HorizonsV1WebsitesWebsiteUrlResource

Authorization

apiToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publish_website_v1

HorizonsV1WebsitesPublishedWebsiteResource publish_website_v1(website_id)

Publish website

Publish a Hostinger Horizons website so its latest changes go live.\n Use this tool when the user asks to publish, deploy or make their website live.\n This tool starts the publish process and returns the URL the website will be live on. Publishing happens asynchronously and takes a few minutes.\n After invoking this tool, your chat reply must be EXACTLY 1 sentence summarizing that the website is being published and you should provide the published URL to the user immediately.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.horizons_v1_websites_published_website_resource import HorizonsV1WebsitesPublishedWebsiteResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.HorizonsWebsitesApi(api_client)
    website_id = '123e4567-e89b-12d3-a456-426614174000' # str | The website ID

    try:
        # Publish website
        api_response = api_instance.publish_website_v1(website_id)
        print("The response of HorizonsWebsitesApi->publish_website_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HorizonsWebsitesApi->publish_website_v1: %s\n" % e)

Parameters

Name Type Description Notes
website_id str The website ID

Return type

HorizonsV1WebsitesPublishedWebsiteResource

Authorization

apiToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]