Home
Version 3
Domains (deprecated) API

Domains (deprecated) API

creates a shared domain (deprecated)

POST /v2/domains

Fields

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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzOSIsImVtYWlsIjoiZW1haWwtMTc5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDh9.N2iFL0oEwxca-xDBc1PyDJ5j057Q2q5tlkUkSTw4Ofo
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

POST /v2/domains

Body

{
  "name": "example.com",
  "wildcard": true
}

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/domains/b75c4563-19df-4a51-9d28-5bf636db2432
X-VCAP-Request-ID: 90fb0ec4-9cd7-4747-a465-d8deb45b5816
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 291
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "b75c4563-19df-4a51-9d28-5bf636db2432",
    "url": "/v2/domains/b75c4563-19df-4a51-9d28-5bf636db2432",
    "created_at": "2015-01-20T01:52:28+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "example.com",
    "owning_organization_guid": null
  }
}