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.eyJ1c2VyX2lkIjoidWFhLWlkLTY3IiwiZW1haWwiOiJlbWFpbC02NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ4fQ.ZTLcZWPlHKFqENnxkBUgCegfPYXKgDvgAXl9uDIx0TA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY3IiwiZW1haWwiOiJlbWFpbC02NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ4fQ.ZTLcZWPlHKFqENnxkBUgCegfPYXKgDvgAXl9uDIx0TA" \
	-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": "6d07beec-57dc-4d6c-b1ed-559550b27604",
        "url": "/v2/private_domains/6d07beec-57dc-4d6c-b1ed-559550b27604",
        "created_at": "2015-06-16T23:40:41Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "13fd7e95-5dc7-483d-a6c0-e55c6332a100",
        "owning_organization_url": "/v2/organizations/13fd7e95-5dc7-483d-a6c0-e55c6332a100",
        "shared_organizations_url": "/v2/private_domains/6d07beec-57dc-4d6c-b1ed-559550b27604/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "4b80c814-a46b-4ceb-94e2-d1a5c532a4b3",
        "url": "/v2/private_domains/4b80c814-a46b-4ceb-94e2-d1a5c532a4b3",
        "created_at": "2015-06-16T23:40:48Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-41.example.com",
        "owning_organization_guid": "1d6f4bc7-13da-4583-a9c4-7f4fa0b207fc",
        "owning_organization_url": "/v2/organizations/1d6f4bc7-13da-4583-a9c4-7f4fa0b207fc",
        "shared_organizations_url": "/v2/private_domains/4b80c814-a46b-4ceb-94e2-d1a5c532a4b3/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "e2a391d8-5871-497b-b799-692c02b4525c",
        "url": "/v2/private_domains/e2a391d8-5871-497b-b799-692c02b4525c",
        "created_at": "2015-06-16T23:40:48Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-42.example.com",
        "owning_organization_guid": "b87f0aca-96cc-4edc-8bcf-6decf8cee5ac",
        "owning_organization_url": "/v2/organizations/b87f0aca-96cc-4edc-8bcf-6decf8cee5ac",
        "shared_organizations_url": "/v2/private_domains/e2a391d8-5871-497b-b799-692c02b4525c/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "9e3110a2-b174-4c14-9842-ed814f02b411",
        "url": "/v2/private_domains/9e3110a2-b174-4c14-9842-ed814f02b411",
        "created_at": "2015-06-16T23:40:48Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-43.example.com",
        "owning_organization_guid": "e565f378-fc76-477c-bb83-f9ec90589bcd",
        "owning_organization_url": "/v2/organizations/e565f378-fc76-477c-bb83-f9ec90589bcd",
        "shared_organizations_url": "/v2/private_domains/9e3110a2-b174-4c14-9842-ed814f02b411/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6c76d0a8-ea10-4bd6-a68b-1a1c99fae6f5
Content-Length: 2483
X-Content-Type-Options: nosniff