Get Deployment Domain Name for a resource kind

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get Deployment Domain Name for a resource kind

edit

Gets Deployment Domain Name configuration value for a resource kind.

Request

edit

GET /api/v1/platform/configuration/networking/deployment_domain_name/{resource_kind}

Path parameters

edit

Name	Type	Required	Description
`resource_kind`	`string`; allowed values: [`elasticsearch`, `kibana`, `apm`, `appsearch`, `enterprise_search`, `integrations_server`]	Y	The kind of resource you want to manage a Deployment Domain Name for.

Responses

edit

200

(DeploymentDomainName)

The Deployment Domain Name was successfully retrieved

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

404

(BasicFailedReply)

There is no configured Deployment Domain Name but optimistic locking was sent. (code: networking.cname.not_found)

Headers

x-cloud-error-codes (string; allowed values: [networking.cname.not_found]): The error codes associated with the response

Request example

edit

curl -XGET https://{{hostname}}/api/v1/platform/configuration/networking/deployment_domain_name/{resource_kind} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Set default Deployment Domain Name Set Deployment Domain Name for a resource kind. »