Home
Version 3
Private Domains API

Private Domains API

Delete a Particular Private Domain

DELETE /v2/private_domains/:guid

Fields

Name Description Default Valid Values Example Values
guid The guid of the domain.
name The name of the domain.
  • example.com
  • foo.example.com
owning_organization_guid The organization that owns the domain. If not specified, the domain is shared.

Parameters

Name Description Valid Values Example Values
guid The guid of the Private Domain
async Will run the delete request in a background job. Recommended: 'true'.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYxIiwiZW1haWwiOiJlbWFpbC01NEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk4fQ.i9GGey1TdiN3UJTb9gtnm2Zcg_XNqsmce3te2F-dxDo
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

Route

DELETE /v2/private_domains/b118450b-5ee6-479c-a9bc-0c3207529d18

cURL

curl "https://api.[your-domain.com]/v2/private_domains/b118450b-5ee6-479c-a9bc-0c3207529d18" -d '' -X DELETE \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYxIiwiZW1haWwiOiJlbWFpbC01NEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk4fQ.i9GGey1TdiN3UJTb9gtnm2Zcg_XNqsmce3te2F-dxDo" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Headers

X-VCAP-Request-ID: d664ee1b-e865-47fd-8180-5c05926b701c
X-Content-Type-Options: nosniff

Status

204 No Content