It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Get Deployment Domain Name for a resource kind Platform »

› › › ›

Set Deployment Domain Name for a resource kind.

edit

Set Deployment Domain Name for a resource kind.

edit

Saves the Deployment Domain Name configuration value for a resource kind.

Request

edit

PUT /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`]	Y	The kind of resource you want to manage a Deployment Domain Name for.

Query parameters

edit

Name	Type	Required	Description
`skip_cascading_operations`	`boolean`; default: `false`	N	Whether or not to skip cascading operations, such as re-provisioning the Security Deployment.
`version`	`string`	N	If specified, then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request). If not specified, will unconditionally upsert.

Request body

edit

(DeploymentDomainName) (required) Data containing the Deployment Domain Name to set

Responses

edit

200

(DeploymentDomainName) The Deployment Domain Name was successfully saved.

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

400

(BasicFailedReply) The optimistic locking version format was wrong. (code: networking.cname.bad_version_format)

Headers

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

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

409

(BasicFailedReply) There was an optimistic locking version conflict. (code: networking.cname.version_conflict)

Headers

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

412

(BasicFailedReply) skip_cascading_operations was false but the Security Deployment already had a pending plan. (code: security_deployment.cluster_pending_plan_exists)

Headers

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

curl -XPUT https://{{hostname}}/api/v1/platform/configuration/networking/deployment_domain_name/{resource_kind} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "value" : "string"
}
'

« Get Deployment Domain Name for a resource kind Platform »