Home
Version 3
Domains (deprecated) API

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.eyJ1c2VyX2lkIjoidWFhLWlkLTciLCJlbWFpbCI6ImVtYWlsLTdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxOTk4OTk2MH0.bMw0RT2C5hb6YwhHRINw19TP6UX3HfY1NxrF38dcylg
Host: example.org
Cookie: 

Route

GET /v2/domains

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c5416994-3b4b-49f0-8b26-dbe507b1bb0e
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 1583
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 4,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1fe34a07-08b6-4c40-992f-c5be55aec931",
        "url": "/v2/domains/1fe34a07-08b6-4c40-992f-c5be55aec931",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "d68c1534-fd76-4c83-94e4-b298ff0d5379",
        "url": "/v2/domains/d68c1534-fd76-4c83-94e4-b298ff0d5379",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "b73e8a9e-c7b8-4a8d-9c6b-2a43a649937f",
        "url": "/v2/domains/b73e8a9e-c7b8-4a8d-9c6b-2a43a649937f",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "0aa53a0e-e737-49d4-9880-62d4eb4b7b61",
        "owning_organization_url": "/v2/organizations/0aa53a0e-e737-49d4-9880-62d4eb4b7b61",
        "spaces_url": "/v2/domains/b73e8a9e-c7b8-4a8d-9c6b-2a43a649937f/spaces"
      }
    },
    {
      "metadata": {
        "guid": "4c9ea3c5-3270-4911-8acd-738743f20dde",
        "url": "/v2/domains/4c9ea3c5-3270-4911-8acd-738743f20dde",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-17.example.com"
      }
    }
  ]
}