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.eyJ1c2VyX2lkIjoidWFhLWlkLTM5OCIsImVtYWlsIjoiZW1haWwtMjk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMjJ9.ossQS1FdQZNzeJlaNnkkgGEDH8Y1Vuoy2fEC8sRh50I
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5OCIsImVtYWlsIjoiZW1haWwtMjk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMjJ9.ossQS1FdQZNzeJlaNnkkgGEDH8Y1Vuoy2fEC8sRh50I" \
	-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": "da043f66-9e31-4c3f-9627-d15654a7e961",
        "url": "/v2/private_domains/da043f66-9e31-4c3f-9627-d15654a7e961",
        "created_at": "2015-06-04T00:05:16Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "ce264da0-224b-4d56-aaed-2558f83f889b",
        "owning_organization_url": "/v2/organizations/ce264da0-224b-4d56-aaed-2558f83f889b",
        "shared_organizations_url": "/v2/private_domains/da043f66-9e31-4c3f-9627-d15654a7e961/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "7433de32-e716-4720-9a75-234d75466acf",
        "url": "/v2/private_domains/7433de32-e716-4720-9a75-234d75466acf",
        "created_at": "2015-06-04T00:05:22Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-61.example.com",
        "owning_organization_guid": "370b5e7c-1219-4cc9-9068-38d427e4373c",
        "owning_organization_url": "/v2/organizations/370b5e7c-1219-4cc9-9068-38d427e4373c",
        "shared_organizations_url": "/v2/private_domains/7433de32-e716-4720-9a75-234d75466acf/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "2bea7080-fb3d-44ed-b31b-fd9b726b3dc5",
        "url": "/v2/private_domains/2bea7080-fb3d-44ed-b31b-fd9b726b3dc5",
        "created_at": "2015-06-04T00:05:22Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-62.example.com",
        "owning_organization_guid": "0036d131-120f-4afc-987f-83b5f2a37595",
        "owning_organization_url": "/v2/organizations/0036d131-120f-4afc-987f-83b5f2a37595",
        "shared_organizations_url": "/v2/private_domains/2bea7080-fb3d-44ed-b31b-fd9b726b3dc5/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "6aa8b24a-9cd8-4b31-bcc7-ee33c3b39bfa",
        "url": "/v2/private_domains/6aa8b24a-9cd8-4b31-bcc7-ee33c3b39bfa",
        "created_at": "2015-06-04T00:05:22Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-63.example.com",
        "owning_organization_guid": "41d9182b-03c5-431a-80f1-5538622d642b",
        "owning_organization_url": "/v2/organizations/41d9182b-03c5-431a-80f1-5538622d642b",
        "shared_organizations_url": "/v2/private_domains/6aa8b24a-9cd8-4b31-bcc7-ee33c3b39bfa/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9cd66620-7c65-476d-89a1-ab2df45b8c6e
Content-Length: 2483
X-Content-Type-Options: nosniff