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.eyJ1c2VyX2lkIjoidWFhLWlkLTM1NyIsImVtYWlsIjoiZW1haWwtMjU5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MjF9.Sa1S7EGbf5zXPJNsF2pxjInv7JVXyyTVk9i34L7oZxs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1NyIsImVtYWlsIjoiZW1haWwtMjU5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MjF9.Sa1S7EGbf5zXPJNsF2pxjInv7JVXyyTVk9i34L7oZxs" \
	-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": "603a6517-448e-4a61-9f1d-3389dd3173d0",
        "url": "/v2/private_domains/603a6517-448e-4a61-9f1d-3389dd3173d0",
        "created_at": "2015-03-10T23:11:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "27279ccf-890a-4c15-a933-6cba3f992b21",
        "owning_organization_url": "/v2/organizations/27279ccf-890a-4c15-a933-6cba3f992b21",
        "shared_organizations_url": "/v2/private_domains/603a6517-448e-4a61-9f1d-3389dd3173d0/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "a3ecf369-c4fa-4cc1-a45d-94b11711b2c1",
        "url": "/v2/private_domains/a3ecf369-c4fa-4cc1-a45d-94b11711b2c1",
        "created_at": "2015-03-10T23:12:01Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-45.example.com",
        "owning_organization_guid": "9ff6e14d-0f26-443a-ab3d-0d362f8e654f",
        "owning_organization_url": "/v2/organizations/9ff6e14d-0f26-443a-ab3d-0d362f8e654f",
        "shared_organizations_url": "/v2/private_domains/a3ecf369-c4fa-4cc1-a45d-94b11711b2c1/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "7e22b651-adb5-443c-8da0-f3c45fcdcca8",
        "url": "/v2/private_domains/7e22b651-adb5-443c-8da0-f3c45fcdcca8",
        "created_at": "2015-03-10T23:12:01Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-46.example.com",
        "owning_organization_guid": "e12e4e4f-76b8-497f-9710-fc6d14274e4b",
        "owning_organization_url": "/v2/organizations/e12e4e4f-76b8-497f-9710-fc6d14274e4b",
        "shared_organizations_url": "/v2/private_domains/7e22b651-adb5-443c-8da0-f3c45fcdcca8/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "3418c098-7d11-45d2-9318-4d7c56c716f5",
        "url": "/v2/private_domains/3418c098-7d11-45d2-9318-4d7c56c716f5",
        "created_at": "2015-03-10T23:12:01Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-47.example.com",
        "owning_organization_guid": "27f4b5da-3cff-436f-aa71-e29bd55ad535",
        "owning_organization_url": "/v2/organizations/27f4b5da-3cff-436f-aa71-e29bd55ad535",
        "shared_organizations_url": "/v2/private_domains/3418c098-7d11-45d2-9318-4d7c56c716f5/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3468048a-6043-4797-a7cd-6677d76ac0d4
Content-Length: 2483
X-Content-Type-Options: nosniff