Home
Version 3
Shared Domains API

Shared Domains API

Delete a Particular Shared Domain

DELETE /v2/shared_domains/:guid

Request

Route

DELETE /v2/shared_domains/e63b955d-66c6-4d6e-8a66-b68260c4f670

Parameters

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

Body

Name Description Default Valid Values Example Values
guid The guid of the domain.
name The name of the domain.
  • example.com
  • foo.example.com

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MiIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5Njh9.5mpAEbSTfXaGUSvDj_eP6T5nGfvPGMP9qW7XS8FpeU0
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/e63b955d-66c6-4d6e-8a66-b68260c4f670" -d '' -X DELETE \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MiIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5Njh9.5mpAEbSTfXaGUSvDj_eP6T5nGfvPGMP9qW7XS8FpeU0" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: d6061282-3972-4596-9525-76041bf823ef
X-Content-Type-Options: nosniff