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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtOTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MTk1ODM5Nn0.urRjcCxwCLBSVgmCg12MJvqF3Lp6DaR31Z7TaziztgU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtOTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MTk1ODM5Nn0.urRjcCxwCLBSVgmCg12MJvqF3Lp6DaR31Z7TaziztgU" \
	-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": "fb7cda2a-dc41-4490-863e-d7a0bdfa301f",
        "url": "/v2/private_domains/fb7cda2a-dc41-4490-863e-d7a0bdfa301f",
        "created_at": "2016-04-22T19:33:13Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "7d946631-d25b-4c5a-ac58-ccea1490666c",
        "owning_organization_url": "/v2/organizations/7d946631-d25b-4c5a-ac58-ccea1490666c",
        "shared_organizations_url": "/v2/private_domains/fb7cda2a-dc41-4490-863e-d7a0bdfa301f/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "3165e1dd-59df-4fba-9d1a-bf188019b52d",
        "url": "/v2/private_domains/3165e1dd-59df-4fba-9d1a-bf188019b52d",
        "created_at": "2016-04-22T19:33:16Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-9.example.com",
        "owning_organization_guid": "9d6d9181-17e1-452e-8337-ad4cadbd3b88",
        "owning_organization_url": "/v2/organizations/9d6d9181-17e1-452e-8337-ad4cadbd3b88",
        "shared_organizations_url": "/v2/private_domains/3165e1dd-59df-4fba-9d1a-bf188019b52d/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "9b28fcdc-2187-442a-90f7-4bacafd9ac2c",
        "url": "/v2/private_domains/9b28fcdc-2187-442a-90f7-4bacafd9ac2c",
        "created_at": "2016-04-22T19:33:16Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-10.example.com",
        "owning_organization_guid": "9e62e484-7fd1-40fb-8946-798020bb9c82",
        "owning_organization_url": "/v2/organizations/9e62e484-7fd1-40fb-8946-798020bb9c82",
        "shared_organizations_url": "/v2/private_domains/9b28fcdc-2187-442a-90f7-4bacafd9ac2c/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "65f12a9d-59b4-413b-8e88-94bf2fbcf932",
        "url": "/v2/private_domains/65f12a9d-59b4-413b-8e88-94bf2fbcf932",
        "created_at": "2016-04-22T19:33:16Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-11.example.com",
        "owning_organization_guid": "226234d0-d514-4c34-9a52-dce866f80d69",
        "owning_organization_url": "/v2/organizations/226234d0-d514-4c34-9a52-dce866f80d69",
        "shared_organizations_url": "/v2/private_domains/65f12a9d-59b4-413b-8e88-94bf2fbcf932/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9e627ce2-40e2-4bec-b5ce-6e10959e1094
Content-Length: 2482
X-Content-Type-Options: nosniff