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/767022a4-9669-4bce-ad4d-5e68061b03f4

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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMSIsImVtYWlsIjoiZW1haWwtNjdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjU5OH0.OJcW1Q_mY71WjldhTm1QJt7I6LQ9aGHcXbrk-S5--i0
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains/767022a4-9669-4bce-ad4d-5e68061b03f4" -d '' -X DELETE \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMSIsImVtYWlsIjoiZW1haWwtNjdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjU5OH0.OJcW1Q_mY71WjldhTm1QJt7I6LQ9aGHcXbrk-S5--i0" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: 117c0142-d45c-4249-aa9f-a4edbc8ecb1d
X-Content-Type-Options: nosniff