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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OSIsImVtYWlsIjoiZW1haWwtMjAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTN9.e68yKezhAsgV0d00Ii0sRC0SCY2e_UOC0Bu8YbiEr_I
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OSIsImVtYWlsIjoiZW1haWwtMjAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTN9.e68yKezhAsgV0d00Ii0sRC0SCY2e_UOC0Bu8YbiEr_I" \
	-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": "159aa6b5-89d1-4021-a883-5c265c7d1a0a",
        "url": "/v2/domains/159aa6b5-89d1-4021-a883-5c265c7d1a0a",
        "created_at": "2015-10-13T17:31:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "12b8addd-be70-4a3c-956f-28d05edbb193",
        "url": "/v2/domains/12b8addd-be70-4a3c-956f-28d05edbb193",
        "created_at": "2015-10-13T17:31:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "46fb94be-e622-41d7-96cc-4f9d13f45c22",
        "url": "/v2/domains/46fb94be-e622-41d7-96cc-4f9d13f45c22",
        "created_at": "2015-10-13T17:31:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "8d7bb68f-7131-4bde-9f2c-329c414b8969",
        "owning_organization_url": "/v2/organizations/8d7bb68f-7131-4bde-9f2c-329c414b8969",
        "spaces_url": "/v2/domains/46fb94be-e622-41d7-96cc-4f9d13f45c22/spaces"
      }
    },
    {
      "metadata": {
        "guid": "a34a3144-23de-4ba6-a699-bb8bd5662f72",
        "url": "/v2/domains/a34a3144-23de-4ba6-a699-bb8bd5662f72",
        "created_at": "2015-10-13T17:31:53Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-37.example.com",
        "router_group_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 44daf81e-81b0-4460-a674-b0a51bc4b217
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 1668
X-Content-Type-Options: nosniff