Home
Version 3
Domains (deprecated) API

Domains (deprecated) API

Create a Shared Domain (deprecated)

POST /v2/domains

Request

Route

POST /v2/domains

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
wildcard Allow routes with non-empty hosts
  • true
  • false
owning_organization_guid The organization that owns the domain. If not specified, the domain is shared.
{
  "name": "example.com",
  "wildcard": true
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MCIsImVtYWlsIjoiZW1haWwtMTAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1MzR9.JRMX9_B6c_bK-diGO36unAtbTYK2tlrS8cSJ_2Wa4jk
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/domains" -d '{
  "name": "example.com",
  "wildcard": true
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MCIsImVtYWlsIjoiZW1haWwtMTAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1MzR9.JRMX9_B6c_bK-diGO36unAtbTYK2tlrS8cSJ_2Wa4jk" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "9ec78831-54e8-4454-bcfc-f6ed7a825085",
    "url": "/v2/domains/9ec78831-54e8-4454-bcfc-f6ed7a825085",
    "created_at": "2015-09-11T18:38:54Z",
    "updated_at": null
  },
  "entity": {
    "name": "example.com",
    "owning_organization_guid": null,
    "shared_organizations": [

    ]
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/domains/9ec78831-54e8-4454-bcfc-f6ed7a825085
X-VCAP-Request-ID: a712d8b2-ae7f-4d91-be77-02199bfb4755
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 324
X-Content-Type-Options: nosniff