Home
Version 3
Private Domains API

Private Domains API

List all Private Domains

GET /v2/private_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
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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNCIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjMyMzUzNn0.0ot5wFmYGXm0pvqway9M9AC7wOvfETR8uBJLipFBc-M
Host: example.org
Cookie: 

Route

GET /v2/private_domains

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNCIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjMyMzUzNn0.0ot5wFmYGXm0pvqway9M9AC7wOvfETR8uBJLipFBc-M" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 20cdf15d-5905-41dd-9200-bb919b57b2bd
Content-Length: 2035
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 4,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "0780920a-dd73-44ce-b6e6-ae61d79e0947",
        "url": "/v2/private_domains/0780920a-dd73-44ce-b6e6-ae61d79e0947",
        "created_at": "2015-01-20T01:52:15+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "0468a4c0-e364-4d6d-b90a-4b5a27be9092",
        "owning_organization_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092"
      }
    },
    {
      "metadata": {
        "guid": "7013957f-2943-4d19-b3b0-346614490ae3",
        "url": "/v2/private_domains/7013957f-2943-4d19-b3b0-346614490ae3",
        "created_at": "2015-01-20T01:52:16+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-12.example.com",
        "owning_organization_guid": "2837de31-e2c5-42e2-bbb2-7fe072a61ac3",
        "owning_organization_url": "/v2/organizations/2837de31-e2c5-42e2-bbb2-7fe072a61ac3"
      }
    },
    {
      "metadata": {
        "guid": "19ecea26-8553-402f-bf75-95f8904a28a5",
        "url": "/v2/private_domains/19ecea26-8553-402f-bf75-95f8904a28a5",
        "created_at": "2015-01-20T01:52:16+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-13.example.com",
        "owning_organization_guid": "46349f19-6441-4e34-bde7-ec60351212f7",
        "owning_organization_url": "/v2/organizations/46349f19-6441-4e34-bde7-ec60351212f7"
      }
    },
    {
      "metadata": {
        "guid": "af60fc1c-a048-4e97-9281-55c49d0a72fa",
        "url": "/v2/private_domains/af60fc1c-a048-4e97-9281-55c49d0a72fa",
        "created_at": "2015-01-20T01:52:16+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-14.example.com",
        "owning_organization_guid": "465ca49c-1b10-43f3-bd7e-ad232f402fd0",
        "owning_organization_url": "/v2/organizations/465ca49c-1b10-43f3-bd7e-ad232f402fd0"
      }
    }
  ]
}