Skip to content

Latest commit

 

History

History
239 lines (151 loc) · 6.89 KB

DomainApi.md

File metadata and controls

239 lines (151 loc) · 6.89 KB

DomainApi

Note

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

Method HTTP request Description
check_domain GET /service/{service_id}/version/{version_id}/domain/{domain_name}/check Validate DNS configuration for a single domain on a service
create_domain POST /service/{service_id}/version/{version_id}/domain Add a domain name to a service
delete_domain DELETE /service/{service_id}/version/{version_id}/domain/{domain_name} Remove a domain from a service
get_domain GET /service/{service_id}/version/{version_id}/domain/{domain_name} Describe a domain
list_domains GET /service/{service_id}/version/{version_id}/domain List domains
update_domain PUT /service/{service_id}/version/{version_id}/domain/{domain_name} Update a domain

check_domain

Checks the status of a specific domain's DNS record for a Service Version. Returns an array in the same format as domain/check_all.

let cfg = &Configuration::default();
let params = CheckDomainParams {
    // parameters
};
check_domain(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
domain_name String The name of the domain or domains associated with this service. [required]

Return type

Vec<serde_json::Value>

Authorization

token

HTTP request headers

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

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

create_domain

Create a domain for a particular service and version.

let cfg = &Configuration::default();
let params = CreateDomainParams {
    // parameters
};
create_domain(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
comment Option<String> A freeform descriptive note.
name Option<String> The name of the domain or domains associated with this service.

Return type

crate::models::DomainResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

delete_domain

Delete the domain for a particular service and versions.

let cfg = &Configuration::default();
let params = DeleteDomainParams {
    // parameters
};
delete_domain(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
domain_name String The name of the domain or domains associated with this service. [required]

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

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

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

get_domain

Get the domain for a particular service and version.

let cfg = &Configuration::default();
let params = GetDomainParams {
    // parameters
};
get_domain(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
domain_name String The name of the domain or domains associated with this service. [required]

Return type

crate::models::DomainResponse

Authorization

token

HTTP request headers

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

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

list_domains

List all the domains for a particular service and version.

let cfg = &Configuration::default();
let params = ListDomainsParams {
    // parameters
};
list_domains(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]

Return type

Vec<crate::models::DomainResponse>

Authorization

token

HTTP request headers

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

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

update_domain

Update the domain for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateDomainParams {
    // parameters
};
update_domain(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
domain_name String The name of the domain or domains associated with this service. [required]
comment Option<String> A freeform descriptive note.
name Option<String> The name of the domain or domains associated with this service.

Return type

crate::models::DomainResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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