Este conteúdo não está disponível no idioma selecionado.

7.7. Delete a Domain

Description

Delete an existing domain.

Note

The API exits with an error message if there are applications within the domain to be deleted. Therefore, all applications must be deleted before deleting a domain. Setting the force parameter to true automatically deletes all applications under that domain and then deletes the domain.

Warning

Deleting a domain with the force parameter set to true deletes all applications created within that domain. This operation cannot be reversed.

Method and URL Structure

Expand

Method	URL Structure
`DELETE`	`/broker/rest/domains/:name`

Request Parameters

Expand

Name	Description	Required	Default
`force`	Force delete domain	No	`false`

See Section A.3, “Domains” for more information about the valid options applicable to these request parameters.

cURL Command Example

curl -X DELETE https://openshift.redhat.com/broker/rest/domains/mydomain --user user@example.com:password

$ curl -X DELETE https://openshift.redhat.com/broker/rest/domains/mydomain --user user@example.com:password

Copy to Clipboard

Toggle word wrap

JSON Response

If there are applications under the domain to be deleted, the API exits with an error message.

{
    "api_version": 1.6,
    "data": null,
    "messages": [
        {
            "exit_code": 128,
            "field": null,
            "severity": "error",
            "text": "Domain contains applications. Delete applications first or set force to true."
        }
    ],
    "status": "unprocessable_entity",
    "supported_api_versions": [
      1.0,
      1.1,
      1.2,
      1.3,  
      1.4,
      1.5,
      1.6
  	],
	  "type": null,
	  "version": "1.6"
}

{
    "api_version": 1.6,
    "data": null,
    "messages": [
        {
            "exit_code": 128,
            "field": null,
            "severity": "error",
            "text": "Domain contains applications. Delete applications first or set force to true."
        }
    ],
    "status": "unprocessable_entity",
    "supported_api_versions": [
      1.0,
      1.1,
      1.2,
      1.3,  
      1.4,
      1.5,
      1.6
  	],
	  "type": null,
	  "version": "1.6"
}

Copy to Clipboard

Toggle word wrap

In this case, the user must delete all applications that exist under the domain or set the force parameter to true to automatically delete the applications as part of the domain delete process.

Voltar ao topo

Este conteúdo não está disponível no idioma selecionado.

7.7. Delete a Domain

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Tornando o open source mais inclusivo

Sobre a Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links