class Build::DomainsApi

• Build::DomainsApi
• Reference
• Object

Defined in:

build-client/api/domains_api.cr

Constructors

• .new(api_client : Build::ApiClient = ApiClient.default)

Instance Method Summary

• #api_client : ApiClient
• #api_client=(api_client : ApiClient)
• #clear_domains(app_id_or_name : String)

  clear all domains Clear all custom domains from an app @param app_id_or_name [String] app id or name @return [nil]

• #clear_domains_with_http_info(app_id_or_name : String)

  clear all domains Clear all custom domains from an app @param app_id_or_name [String] app id or name @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

• #create_domain(app_id_or_name : String, create_domain_request : CreateDomainRequest | Nil = nil)

  create domain Add a domain to an app @param app_id_or_name [String] app id or name @return [Domain]

• #create_domain_with_http_info(app_id_or_name : String, create_domain_request : CreateDomainRequest | Nil = nil)

  create domain Add a domain to an app @param app_id_or_name [String] app id or name @return [Array<(Domain, Integer, Hash)>] Domain data, response status code and response headers

• #list_domains(app_id_or_name : String)

  list domains List all domains for an app (platform domain + custom domains) @param app_id_or_name [String] app id or name @return [Array(Domain)]

• #list_domains_with_http_info(app_id_or_name : String)

  list domains List all domains for an app (platform domain + custom domains) @param app_id_or_name [String] app id or name @return [Array<(Array(Domain), Integer, Hash)>] Array(Domain) data, response status code and response headers

• #remove_domain(app_id_or_name : String, domain_id : String)

  remove domain Remove a domain from an app @param app_id_or_name [String] app id or name @param domain_id [String] domain id or hostname @return [nil]

• #remove_domain_with_http_info(app_id_or_name : String, domain_id : String)

  remove domain Remove a domain from an app @param app_id_or_name [String] app id or name @param domain_id [String] domain id or hostname @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

• #show_domain(app_id_or_name : String, domain_id : String)

  show domain Get detailed information about a specific domain @param app_id_or_name [String] app id or name @param domain_id [String] domain id or hostname @return [Domain]

• #show_domain_with_http_info(app_id_or_name : String, domain_id : String)

  show domain Get detailed information about a specific domain @param app_id_or_name [String] app id or name @param domain_id [String] domain id or hostname @return [Array<(Domain, Integer, Hash)>] Domain data, response status code and response headers

• #update_domain(app_id_or_name : String, domain_id : String, update_domain_request : UpdateDomainRequest | Nil = nil)

  update domain Update a domain (e.g., change SSL certificate) @param app_id_or_name [String] app id or name @param domain_id [String] domain id or hostname @return [Domain]

• #update_domain_with_http_info(app_id_or_name : String, domain_id : String, update_domain_request : UpdateDomainRequest | Nil = nil)

  update domain Update a domain (e.g., change SSL certificate) @param app_id_or_name [String] app id or name @param domain_id [String] domain id or hostname @return [Array<(Domain, Integer, Hash)>] Domain data, response status code and response headers

Constructor Detail

Instance Method Detail