Domains (deprecated) API

List all Domains (deprecated)

GET /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.

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NyIsImVtYWlsIjoiZW1haWwtMjI3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzl9.wxCqM2qVnMjIVoyR5cr6InNtUVmSPARsIw2inNr2ZL8
Host: example.org
Cookie: 

Route

GET /v2/domains

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ebabc3c6-fd4e-464b-9f8b-c9dc40f4445f
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 1563
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 4,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "5d973024-6e1b-4664-8f54-9a95953462ca",
        "url": "/v2/domains/5d973024-6e1b-4664-8f54-9a95953462ca",
        "created_at": "2015-02-12T01:42:07Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "7eacd3bb-2c75-42f4-952d-840c01dc8af5",
        "url": "/v2/domains/7eacd3bb-2c75-42f4-952d-840c01dc8af5",
        "created_at": "2015-02-12T01:42:07Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "78ba0d29-c944-4708-b511-271f121f26d1",
        "url": "/v2/domains/78ba0d29-c944-4708-b511-271f121f26d1",
        "created_at": "2015-02-12T01:42:07Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "038d0095-d2f6-4a72-a9e2-bf75e790df1c",
        "owning_organization_url": "/v2/organizations/038d0095-d2f6-4a72-a9e2-bf75e790df1c",
        "spaces_url": "/v2/domains/78ba0d29-c944-4708-b511-271f121f26d1/spaces"
      }
    },
    {
      "metadata": {
        "guid": "c92fcc57-80ef-496d-b1b8-66cd3f00fbb1",
        "url": "/v2/domains/c92fcc57-80ef-496d-b1b8-66cd3f00fbb1",
        "created_at": "2015-02-12T01:42:19Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-37.example.com"
      }
    }
  ]
}