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/534c5405-efc8-482b-a5a4-26ee17befb83?

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'.
  • true
  • false

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

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/534c5405-efc8-482b-a5a4-26ee17befb83?" -d '' -X DELETE \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NCIsImVtYWlsIjoiZW1haWwtMTgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NDl9.kUnJCJfcmnCYnHYr2nYRrSJSQbXojIac4LSta8CoWVw" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: 37ffbe36-d27f-42cd-9042-c7d6b77a20f3
X-Content-Type-Options: nosniff