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/aa0a6dd6-f855-4a0c-9268-fb6d13b01cce

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

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/aa0a6dd6-f855-4a0c-9268-fb6d13b01cce" -d '' -X DELETE \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5NSIsImVtYWlsIjoiZW1haWwtMjE2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDh9.vmJEBOOanSD8XyCn2dHAWSV04n28n4OVvhdsFEkDMpU" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: 3d3f8c1c-88bd-4302-9aee-30edd25118f2
X-Content-Type-Options: nosniff