Home
Version 3
Domains (deprecated) API

Domains (deprecated) API

List all Domains (deprecated)

GET /v2/domains

Request

Route

GET /v2/domains

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, owning_organization_guid, space_guid
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

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.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExMSIsImVtYWlsIjoiZW1haWwtODJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjE4Nzc0Mn0.suBFeX3I5XuJttUmqtI-0LFY6oJmZtBZ5LElLADPptA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExMSIsImVtYWlsIjoiZW1haWwtODJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjE4Nzc0Mn0.suBFeX3I5XuJttUmqtI-0LFY6oJmZtBZ5LElLADPptA" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 4,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "3adb79f5-351e-4203-a9f2-b393abac112b",
        "url": "/v2/domains/3adb79f5-351e-4203-a9f2-b393abac112b",
        "created_at": "2015-03-05T19:15:29Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "864950bc-e060-4757-83e7-d0ba9140f2cf",
        "url": "/v2/domains/864950bc-e060-4757-83e7-d0ba9140f2cf",
        "created_at": "2015-03-05T19:15:29Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "35e73dbe-411d-4ca1-8174-3d04bf4f74a2",
        "url": "/v2/domains/35e73dbe-411d-4ca1-8174-3d04bf4f74a2",
        "created_at": "2015-03-05T19:15:29Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "204b56c1-66ab-45da-9aa6-2bacfa5e6584",
        "owning_organization_url": "/v2/organizations/204b56c1-66ab-45da-9aa6-2bacfa5e6584",
        "spaces_url": "/v2/domains/35e73dbe-411d-4ca1-8174-3d04bf4f74a2/spaces"
      }
    },
    {
      "metadata": {
        "guid": "fef0ac7f-3d3a-4e78-b52b-3dd174afddb1",
        "url": "/v2/domains/fef0ac7f-3d3a-4e78-b52b-3dd174afddb1",
        "created_at": "2015-03-05T19:15:42Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-22.example.com"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d3a5154e-df18-4e19-b11f-69d293c246d1
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 1563
X-Content-Type-Options: nosniff