Skip to content

ApplicationCustomDomainApi.md

Latest commit

 

History

History
195 lines (109 loc) · 6.58 KB

ApplicationCustomDomainApi.md

File metadata and controls

195 lines (109 loc) · 6.58 KB
Raw

\ApplicationCustomDomainApi

All URIs are relative to https://api.qovery.com

Method HTTP request Description
check_application_custom_domain GET /application/{applicationId}/checkCustomDomain Check Application Custom Domain
create_application_custom_domain POST /application/{applicationId}/customDomain Add custom domain to the application.
delete_custom_domain DELETE /application/{applicationId}/customDomain/{customDomainId} Delete a Custom Domain
edit_custom_domain PUT /application/{applicationId}/customDomain/{customDomainId} Edit a Custom Domain
get_application_custom_domain GET /application/{applicationId}/customDomain/{customDomainId} Get an application custom domain
list_application_custom_domain GET /application/{applicationId}/customDomain List application custom domains

check_application_custom_domain

models::CheckedCustomDomainsResponse check_application_custom_domain(application_id) Check Application Custom Domain

Parameters

Name Type Description Required Notes
application_id uuid::Uuid Application ID [required]

Return type

models::CheckedCustomDomainsResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

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

create_application_custom_domain

models::CustomDomain create_application_custom_domain(application_id, custom_domain_request) Add custom domain to the application.

Add a custom domain to this application in order not to use qovery autogenerated domain

Parameters

Name Type Description Required Notes
application_id uuid::Uuid Application ID [required]
custom_domain_request Option<CustomDomainRequest>

Return type

models::CustomDomain

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

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

delete_custom_domain

delete_custom_domain(application_id, custom_domain_id) Delete a Custom Domain

To delete an CustomDomain you must have the project user permission

Parameters

Name Type Description Required Notes
application_id uuid::Uuid Application ID [required]
custom_domain_id uuid::Uuid Custom Domain ID [required]

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

edit_custom_domain

models::CustomDomain edit_custom_domain(application_id, custom_domain_id, custom_domain_request) Edit a Custom Domain

To edit a Custom Domain you must have the project user permission

Parameters

Name Type Description Required Notes
application_id uuid::Uuid Application ID [required]
custom_domain_id uuid::Uuid Custom Domain ID [required]
custom_domain_request Option<CustomDomainRequest>

Return type

models::CustomDomain

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

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

get_application_custom_domain

models::CustomDomain get_application_custom_domain(application_id, custom_domain_id) Get an application custom domain

Get a custom domain attached to an application.

Parameters

Name Type Description Required Notes
application_id uuid::Uuid Application ID [required]
custom_domain_id uuid::Uuid Custom Domain ID [required]

Return type

models::CustomDomain

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

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

list_application_custom_domain

models::CustomDomainResponseList list_application_custom_domain(application_id) List application custom domains

Parameters

Name Type Description Required Notes
application_id uuid::Uuid Application ID [required]

Return type

models::CustomDomainResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

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