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.eyJ1c2VyX2lkIjoidWFhLWlkLTM3OSIsImVtYWlsIjoiZW1haWwtMjgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzl9.OuQM9j_YcQcazCUxB2ThAszlEgUf6Hz4HLCrrhUSEak
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3OSIsImVtYWlsIjoiZW1haWwtMjgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2Nzl9.OuQM9j_YcQcazCUxB2ThAszlEgUf6Hz4HLCrrhUSEak" \
	-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": "223d15f0-6342-4ede-8c9c-6598e52ba1a6",
        "url": "/v2/domains/223d15f0-6342-4ede-8c9c-6598e52ba1a6",
        "created_at": "2015-03-03T00:51:04Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "459154fe-89c2-4677-ad6b-b047a0dbe986",
        "url": "/v2/domains/459154fe-89c2-4677-ad6b-b047a0dbe986",
        "created_at": "2015-03-03T00:51:04Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "80bd274b-0f34-4124-8022-f87a1900d6f9",
        "url": "/v2/domains/80bd274b-0f34-4124-8022-f87a1900d6f9",
        "created_at": "2015-03-03T00:51:04Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "0b02a01b-f3fd-4fd4-ba4a-c3978ddb99d8",
        "owning_organization_url": "/v2/organizations/0b02a01b-f3fd-4fd4-ba4a-c3978ddb99d8",
        "spaces_url": "/v2/domains/80bd274b-0f34-4124-8022-f87a1900d6f9/spaces"
      }
    },
    {
      "metadata": {
        "guid": "24ac5a8d-d284-4179-ab3d-f803a5c43d5c",
        "url": "/v2/domains/24ac5a8d-d284-4179-ab3d-f803a5c43d5c",
        "created_at": "2015-03-03T00:51:19Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-61.example.com"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 146ddfc2-c8f1-458b-9828-4799132db84c
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 1563
X-Content-Type-Options: nosniff