Skip to content

Latest commit

 

History

History
229 lines (150 loc) · 7.07 KB

DomainsForwardingApi.md

File metadata and controls

229 lines (150 loc) · 7.07 KB

hostinger_api.DomainsForwardingApi

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

Method HTTP request Description
create_domain_forwarding_v1 POST /api/domains/v1/forwarding Create domain forwarding
delete_domain_forwarding_v1 DELETE /api/domains/v1/forwarding/{domain} Delete domain forwarding
get_domain_forwarding_v1 GET /api/domains/v1/forwarding/{domain} Get domain forwarding

create_domain_forwarding_v1

DomainsV1ForwardingForwardingResource create_domain_forwarding_v1(domains_v1_forwarding_store_request)

Create domain forwarding

Create domain forwarding configuration.

Use this endpoint to set up domain redirects to other URLs.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.domains_v1_forwarding_forwarding_resource import DomainsV1ForwardingForwardingResource
from hostinger_api.models.domains_v1_forwarding_store_request import DomainsV1ForwardingStoreRequest
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.DomainsForwardingApi(api_client)
    domains_v1_forwarding_store_request = hostinger_api.DomainsV1ForwardingStoreRequest() # DomainsV1ForwardingStoreRequest | 

    try:
        # Create domain forwarding
        api_response = api_instance.create_domain_forwarding_v1(domains_v1_forwarding_store_request)
        print("The response of DomainsForwardingApi->create_domain_forwarding_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsForwardingApi->create_domain_forwarding_v1: %s\n" % e)

Parameters

Name Type Description Notes
domains_v1_forwarding_store_request DomainsV1ForwardingStoreRequest

Return type

DomainsV1ForwardingForwardingResource

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]

delete_domain_forwarding_v1

CommonSuccessEmptyResource delete_domain_forwarding_v1(domain)

Delete domain forwarding

Delete domain forwarding data.

Use this endpoint to remove redirect configuration from domains.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
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.DomainsForwardingApi(api_client)
    domain = 'mydomain.tld' # str | Domain name

    try:
        # Delete domain forwarding
        api_response = api_instance.delete_domain_forwarding_v1(domain)
        print("The response of DomainsForwardingApi->delete_domain_forwarding_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsForwardingApi->delete_domain_forwarding_v1: %s\n" % e)

Parameters

Name Type Description Notes
domain str Domain name

Return type

CommonSuccessEmptyResource

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_domain_forwarding_v1

DomainsV1ForwardingForwardingResource get_domain_forwarding_v1(domain)

Get domain forwarding

Retrieve domain forwarding data.

Use this endpoint to view current redirect configuration for domains.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.domains_v1_forwarding_forwarding_resource import DomainsV1ForwardingForwardingResource
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.DomainsForwardingApi(api_client)
    domain = 'mydomain.tld' # str | Domain name

    try:
        # Get domain forwarding
        api_response = api_instance.get_domain_forwarding_v1(domain)
        print("The response of DomainsForwardingApi->get_domain_forwarding_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsForwardingApi->get_domain_forwarding_v1: %s\n" % e)

Parameters

Name Type Description Notes
domain str Domain name

Return type

DomainsV1ForwardingForwardingResource

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]