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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMiIsImVtYWlsIjoiZW1haWwtODdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzODY0MTc5Mn0.bFevr-ylZxtqrEak7CnFNIuxYJF99cFvvbFcC_i-_2Q
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMiIsImVtYWlsIjoiZW1haWwtODdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzODY0MTc5Mn0.bFevr-ylZxtqrEak7CnFNIuxYJF99cFvvbFcC_i-_2Q" \
	-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": "f17e96a1-74a0-4d01-a9e0-c45cb36f1134",
        "url": "/v2/private_domains/f17e96a1-74a0-4d01-a9e0-c45cb36f1134",
        "created_at": "2015-07-27T22:43:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "deb3c359-2261-45ba-b34f-ee7487acd71a",
        "owning_organization_url": "/v2/organizations/deb3c359-2261-45ba-b34f-ee7487acd71a",
        "shared_organizations_url": "/v2/private_domains/f17e96a1-74a0-4d01-a9e0-c45cb36f1134/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "ede1adde-1f9a-4a21-8605-47e4818127f6",
        "url": "/v2/private_domains/ede1adde-1f9a-4a21-8605-47e4818127f6",
        "created_at": "2015-07-27T22:43:12Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-21.example.com",
        "owning_organization_guid": "b05c09be-35fa-46e6-8bc4-1413345c1179",
        "owning_organization_url": "/v2/organizations/b05c09be-35fa-46e6-8bc4-1413345c1179",
        "shared_organizations_url": "/v2/private_domains/ede1adde-1f9a-4a21-8605-47e4818127f6/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "b2de180a-daab-4cef-908b-aa2a4df59029",
        "url": "/v2/private_domains/b2de180a-daab-4cef-908b-aa2a4df59029",
        "created_at": "2015-07-27T22:43:12Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-22.example.com",
        "owning_organization_guid": "13ac5246-8047-4e4b-9458-df6f6cac893e",
        "owning_organization_url": "/v2/organizations/13ac5246-8047-4e4b-9458-df6f6cac893e",
        "shared_organizations_url": "/v2/private_domains/b2de180a-daab-4cef-908b-aa2a4df59029/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "470f9684-b93b-4d3f-801b-fc910e189604",
        "url": "/v2/private_domains/470f9684-b93b-4d3f-801b-fc910e189604",
        "created_at": "2015-07-27T22:43:12Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-23.example.com",
        "owning_organization_guid": "a3031cec-01e9-4ca8-8175-272bbb706151",
        "owning_organization_url": "/v2/organizations/a3031cec-01e9-4ca8-8175-272bbb706151",
        "shared_organizations_url": "/v2/private_domains/470f9684-b93b-4d3f-801b-fc910e189604/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 06c854a7-2bd4-4f86-8551-47287d704d3d
Content-Length: 2483
X-Content-Type-Options: nosniff