Home
Version 3
Private Domains API

Private Domains API

List all Private Domains

GET /v2/private_domains

Request

Route

GET /v2/private_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
  • 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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4IiwiZW1haWwiOiJlbWFpbC0yOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTc5fQ.b7pecAp-y6ZEWyZV5kEAo6R1aZy_hxuVzfFMMmKNtO4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4IiwiZW1haWwiOiJlbWFpbC0yOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTc5fQ.b7pecAp-y6ZEWyZV5kEAo6R1aZy_hxuVzfFMMmKNtO4" \
	-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": "56ba7ba5-dc2a-43ae-879c-841d6b82fe89",
        "url": "/v2/private_domains/56ba7ba5-dc2a-43ae-879c-841d6b82fe89",
        "created_at": "2015-05-21T01:02:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "9a346d59-9d39-44cc-9bd0-5ff14ded16ea",
        "owning_organization_url": "/v2/organizations/9a346d59-9d39-44cc-9bd0-5ff14ded16ea",
        "shared_organizations_url": "/v2/private_domains/56ba7ba5-dc2a-43ae-879c-841d6b82fe89/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "b3b7838f-f1cb-48e1-9672-cc1ac6c3cb43",
        "url": "/v2/private_domains/b3b7838f-f1cb-48e1-9672-cc1ac6c3cb43",
        "created_at": "2015-05-21T01:02:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-14.example.com",
        "owning_organization_guid": "77fef8ba-b243-430b-97fc-ff6f6a101dc0",
        "owning_organization_url": "/v2/organizations/77fef8ba-b243-430b-97fc-ff6f6a101dc0",
        "shared_organizations_url": "/v2/private_domains/b3b7838f-f1cb-48e1-9672-cc1ac6c3cb43/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "0b1d4044-9c08-489d-b73b-666d05d4b0ec",
        "url": "/v2/private_domains/0b1d4044-9c08-489d-b73b-666d05d4b0ec",
        "created_at": "2015-05-21T01:02:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-15.example.com",
        "owning_organization_guid": "e171a6cf-f7a1-4add-9b30-afe686184c94",
        "owning_organization_url": "/v2/organizations/e171a6cf-f7a1-4add-9b30-afe686184c94",
        "shared_organizations_url": "/v2/private_domains/0b1d4044-9c08-489d-b73b-666d05d4b0ec/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "f6290ab9-e525-4091-bcb6-0a6852e17a1e",
        "url": "/v2/private_domains/f6290ab9-e525-4091-bcb6-0a6852e17a1e",
        "created_at": "2015-05-21T01:02:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-16.example.com",
        "owning_organization_guid": "2046f379-5065-48b9-a4fb-b8f10005e8ca",
        "owning_organization_url": "/v2/organizations/2046f379-5065-48b9-a4fb-b8f10005e8ca",
        "shared_organizations_url": "/v2/private_domains/f6290ab9-e525-4091-bcb6-0a6852e17a1e/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ceaec6d0-0eb4-431b-94a5-153a972d5353
Content-Length: 2483
X-Content-Type-Options: nosniff