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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxNiIsImVtYWlsIjoiZW1haWwtMTM3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDF9.FNwlgdd4GXGmP5ERNxHYQzZT4goIee0vFQvO9rSPNmw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxNiIsImVtYWlsIjoiZW1haWwtMTM3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDF9.FNwlgdd4GXGmP5ERNxHYQzZT4goIee0vFQvO9rSPNmw" \
	-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": "0e160e60-dd8e-41bb-8d6b-d9a20c2bef0a",
        "url": "/v2/private_domains/0e160e60-dd8e-41bb-8d6b-d9a20c2bef0a",
        "created_at": "2015-04-15T00:55:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "c94aa39f-1ce3-4a0f-b6f6-1c49e35cc9c7",
        "owning_organization_url": "/v2/organizations/c94aa39f-1ce3-4a0f-b6f6-1c49e35cc9c7",
        "shared_organizations_url": "/v2/private_domains/0e160e60-dd8e-41bb-8d6b-d9a20c2bef0a/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "3b71c8e8-1271-4868-b4f2-fd4d3fd03708",
        "url": "/v2/private_domains/3b71c8e8-1271-4868-b4f2-fd4d3fd03708",
        "created_at": "2015-04-15T00:55:41Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-14.example.com",
        "owning_organization_guid": "21aa9875-b3f9-4941-bfc5-263e4de8cb84",
        "owning_organization_url": "/v2/organizations/21aa9875-b3f9-4941-bfc5-263e4de8cb84",
        "shared_organizations_url": "/v2/private_domains/3b71c8e8-1271-4868-b4f2-fd4d3fd03708/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "5ebc09af-d9cf-4dc4-af31-71c5640ab911",
        "url": "/v2/private_domains/5ebc09af-d9cf-4dc4-af31-71c5640ab911",
        "created_at": "2015-04-15T00:55:41Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-15.example.com",
        "owning_organization_guid": "b60ba24c-d1e7-4616-af7d-e01e98945684",
        "owning_organization_url": "/v2/organizations/b60ba24c-d1e7-4616-af7d-e01e98945684",
        "shared_organizations_url": "/v2/private_domains/5ebc09af-d9cf-4dc4-af31-71c5640ab911/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "a1b9309a-cd7c-4f69-a664-4cb6d3b9a39c",
        "url": "/v2/private_domains/a1b9309a-cd7c-4f69-a664-4cb6d3b9a39c",
        "created_at": "2015-04-15T00:55:41Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-16.example.com",
        "owning_organization_guid": "bbc31edd-339b-4841-aeff-68d2a7362387",
        "owning_organization_url": "/v2/organizations/bbc31edd-339b-4841-aeff-68d2a7362387",
        "shared_organizations_url": "/v2/private_domains/a1b9309a-cd7c-4f69-a664-4cb6d3b9a39c/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2683df72-8aec-4e1e-8a7c-e9786871ce30
Content-Length: 2483
X-Content-Type-Options: nosniff