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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3OCIsImVtYWlsIjoiZW1haWwtMTEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2Mjl9.avf_DhLE6krSz1ABxT5N78PaK_Kc6b-XuG1jF2sQEzU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3OCIsImVtYWlsIjoiZW1haWwtMTEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2Mjl9.avf_DhLE6krSz1ABxT5N78PaK_Kc6b-XuG1jF2sQEzU" \
	-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": "e205ca45-e6ab-4818-acb8-1ad269d54766",
        "url": "/v2/private_domains/e205ca45-e6ab-4818-acb8-1ad269d54766",
        "created_at": "2016-04-16T01:23:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "987056a4-f070-41d6-8968-348b427f4fe5",
        "owning_organization_url": "/v2/organizations/987056a4-f070-41d6-8968-348b427f4fe5",
        "shared_organizations_url": "/v2/private_domains/e205ca45-e6ab-4818-acb8-1ad269d54766/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "c5b2e4d6-b1b1-4b0a-8932-a2fef742bb5d",
        "url": "/v2/private_domains/c5b2e4d6-b1b1-4b0a-8932-a2fef742bb5d",
        "created_at": "2016-04-16T01:23:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-21.example.com",
        "owning_organization_guid": "0feeb4f6-518c-429a-b960-d9cfe29b1ae4",
        "owning_organization_url": "/v2/organizations/0feeb4f6-518c-429a-b960-d9cfe29b1ae4",
        "shared_organizations_url": "/v2/private_domains/c5b2e4d6-b1b1-4b0a-8932-a2fef742bb5d/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "c2541d2c-26cd-400c-997c-45531e9394a1",
        "url": "/v2/private_domains/c2541d2c-26cd-400c-997c-45531e9394a1",
        "created_at": "2016-04-16T01:23:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-22.example.com",
        "owning_organization_guid": "0271e937-f34b-4afe-a909-571b93c3ee6c",
        "owning_organization_url": "/v2/organizations/0271e937-f34b-4afe-a909-571b93c3ee6c",
        "shared_organizations_url": "/v2/private_domains/c2541d2c-26cd-400c-997c-45531e9394a1/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "6e08f2b9-5ded-4859-b2a1-5630bb1f7e9f",
        "url": "/v2/private_domains/6e08f2b9-5ded-4859-b2a1-5630bb1f7e9f",
        "created_at": "2016-04-16T01:23:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-23.example.com",
        "owning_organization_guid": "6901f032-1489-46f4-97d5-e75de3420747",
        "owning_organization_url": "/v2/organizations/6901f032-1489-46f4-97d5-e75de3420747",
        "shared_organizations_url": "/v2/private_domains/6e08f2b9-5ded-4859-b2a1-5630bb1f7e9f/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ee8f85ad-1509-4308-9ee5-8b2a7753f054
Content-Length: 2483
X-Content-Type-Options: nosniff