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/1cad2f80-74fb-4b4d-8365-33bd38c5798c

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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NyIsImVtYWlsIjoiZW1haWwtMjA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYyMDl9.mHIjakp6VuEob4yKaN784gYkRpruEJ-QF1C6vTm_x7I
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/1cad2f80-74fb-4b4d-8365-33bd38c5798c" -d '' -X DELETE \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NyIsImVtYWlsIjoiZW1haWwtMjA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYyMDl9.mHIjakp6VuEob4yKaN784gYkRpruEJ-QF1C6vTm_x7I" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: 943be719-3e4a-4be9-8602-08cbe9d33c2d
X-Content-Type-Options: nosniff