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.eyJ1c2VyX2lkIjoidWFhLWlkLTYwIiwiZW1haWwiOiJlbWFpbC01M0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk4fQ.vndXWHQSB5m9iybgrHTCKEcYz44CAs1pFFMm9--EUzk
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.eyJ1c2VyX2lkIjoidWFhLWlkLTYwIiwiZW1haWwiOiJlbWFpbC01M0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk4fQ.vndXWHQSB5m9iybgrHTCKEcYz44CAs1pFFMm9--EUzk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a4070233-caf2-4168-b675-f5e9202f4aa2
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": "b118450b-5ee6-479c-a9bc-0c3207529d18",
        "url": "/v2/private_domains/b118450b-5ee6-479c-a9bc-0c3207529d18",
        "created_at": "2014-11-13T23:38:13+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "e9b1224d-58da-40b9-85ed-15c05d6684c2",
        "owning_organization_url": "/v2/organizations/e9b1224d-58da-40b9-85ed-15c05d6684c2"
      }
    },
    {
      "metadata": {
        "guid": "d2e95c7f-52db-4252-901d-4b80c8423446",
        "url": "/v2/private_domains/d2e95c7f-52db-4252-901d-4b80c8423446",
        "created_at": "2014-11-13T23:38:18+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-27.example.com",
        "owning_organization_guid": "740963bf-ce73-4132-891c-7e3c48de4473",
        "owning_organization_url": "/v2/organizations/740963bf-ce73-4132-891c-7e3c48de4473"
      }
    },
    {
      "metadata": {
        "guid": "09934b73-2fbf-44cf-b874-1fc232afc20a",
        "url": "/v2/private_domains/09934b73-2fbf-44cf-b874-1fc232afc20a",
        "created_at": "2014-11-13T23:38:18+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-28.example.com",
        "owning_organization_guid": "e730cdab-7dcb-49e1-a473-b82443120c9b",
        "owning_organization_url": "/v2/organizations/e730cdab-7dcb-49e1-a473-b82443120c9b"
      }
    },
    {
      "metadata": {
        "guid": "ab8d25d8-4b10-4868-bbe3-8108578f0dc1",
        "url": "/v2/private_domains/ab8d25d8-4b10-4868-bbe3-8108578f0dc1",
        "created_at": "2014-11-13T23:38:18+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-29.example.com",
        "owning_organization_guid": "dc26c499-2ee5-4077-a7c0-473f97375b39",
        "owning_organization_url": "/v2/organizations/dc26c499-2ee5-4077-a7c0-473f97375b39"
      }
    }
  ]
}