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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0MSIsImVtYWlsIjoiZW1haWwtMjAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NDR9.24Gj2g5nAGx7oaKNw7qMqDEDtWVq1nwKwf1dgGVyxc8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0MSIsImVtYWlsIjoiZW1haWwtMjAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NDR9.24Gj2g5nAGx7oaKNw7qMqDEDtWVq1nwKwf1dgGVyxc8" \
	-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": "e9f30ace-654d-4597-88ec-0b3e11b3316c",
        "url": "/v2/private_domains/e9f30ace-654d-4597-88ec-0b3e11b3316c",
        "created_at": "2016-03-14T22:30:39Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "402eaf40-b303-4e98-b3ff-768b8c5e4577",
        "owning_organization_url": "/v2/organizations/402eaf40-b303-4e98-b3ff-768b8c5e4577",
        "shared_organizations_url": "/v2/private_domains/e9f30ace-654d-4597-88ec-0b3e11b3316c/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "76ddc3f9-9070-4c3f-8311-ab7197fa0a9a",
        "url": "/v2/private_domains/76ddc3f9-9070-4c3f-8311-ab7197fa0a9a",
        "created_at": "2016-03-14T22:30:44Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-72.example.com",
        "owning_organization_guid": "472f8bd3-f2fc-4fb1-b4d9-e69a3bba8e62",
        "owning_organization_url": "/v2/organizations/472f8bd3-f2fc-4fb1-b4d9-e69a3bba8e62",
        "shared_organizations_url": "/v2/private_domains/76ddc3f9-9070-4c3f-8311-ab7197fa0a9a/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "69bed3b5-70bf-430d-8c2b-f10c47f744f2",
        "url": "/v2/private_domains/69bed3b5-70bf-430d-8c2b-f10c47f744f2",
        "created_at": "2016-03-14T22:30:44Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-73.example.com",
        "owning_organization_guid": "5aa7a31a-02be-4f0a-83b9-2a4cff4b2a89",
        "owning_organization_url": "/v2/organizations/5aa7a31a-02be-4f0a-83b9-2a4cff4b2a89",
        "shared_organizations_url": "/v2/private_domains/69bed3b5-70bf-430d-8c2b-f10c47f744f2/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "a2f69b30-a6f4-47e7-adf3-ed98c111de42",
        "url": "/v2/private_domains/a2f69b30-a6f4-47e7-adf3-ed98c111de42",
        "created_at": "2016-03-14T22:30:44Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-74.example.com",
        "owning_organization_guid": "bdc19798-9da1-476f-ae6a-4c9195ea3a02",
        "owning_organization_url": "/v2/organizations/bdc19798-9da1-476f-ae6a-4c9195ea3a02",
        "shared_organizations_url": "/v2/private_domains/a2f69b30-a6f4-47e7-adf3-ed98c111de42/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 2483
X-Content-Type-Options: nosniff