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.eyJ1c2VyX2lkIjoidWFhLWlkLTQwNiIsImVtYWlsIjoiZW1haWwtMzAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTd9.bGpdD2_A5Jn4hJLPUOx6gH2iEHOM8srvo11xzxsVa-0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQwNiIsImVtYWlsIjoiZW1haWwtMzAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTd9.bGpdD2_A5Jn4hJLPUOx6gH2iEHOM8srvo11xzxsVa-0" \
	-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": "fcc62c40-d192-48c4-87c5-bc8aa056202c",
        "url": "/v2/private_domains/fcc62c40-d192-48c4-87c5-bc8aa056202c",
        "created_at": "2015-11-03T00:54:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "dd630dce-1cc8-4051-a94b-8a7f2ac8f597",
        "owning_organization_url": "/v2/organizations/dd630dce-1cc8-4051-a94b-8a7f2ac8f597",
        "shared_organizations_url": "/v2/private_domains/fcc62c40-d192-48c4-87c5-bc8aa056202c/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "58299a41-c253-4e4e-b9fe-699004db4c39",
        "url": "/v2/private_domains/58299a41-c253-4e4e-b9fe-699004db4c39",
        "created_at": "2015-11-03T00:54:17Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-51.example.com",
        "owning_organization_guid": "c4dd7c55-c5ea-499b-ada8-cd22ba12ed44",
        "owning_organization_url": "/v2/organizations/c4dd7c55-c5ea-499b-ada8-cd22ba12ed44",
        "shared_organizations_url": "/v2/private_domains/58299a41-c253-4e4e-b9fe-699004db4c39/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "ed4835c8-8dd1-497a-9382-723931194557",
        "url": "/v2/private_domains/ed4835c8-8dd1-497a-9382-723931194557",
        "created_at": "2015-11-03T00:54:17Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-52.example.com",
        "owning_organization_guid": "db035a60-5335-46e1-b73e-30eeb2333e37",
        "owning_organization_url": "/v2/organizations/db035a60-5335-46e1-b73e-30eeb2333e37",
        "shared_organizations_url": "/v2/private_domains/ed4835c8-8dd1-497a-9382-723931194557/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "3fd5eeee-7e92-4898-93b5-85e06a9ed5da",
        "url": "/v2/private_domains/3fd5eeee-7e92-4898-93b5-85e06a9ed5da",
        "created_at": "2015-11-03T00:54:17Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-53.example.com",
        "owning_organization_guid": "edfcd355-93eb-4f37-be5b-0f6ef01bb287",
        "owning_organization_url": "/v2/organizations/edfcd355-93eb-4f37-be5b-0f6ef01bb287",
        "shared_organizations_url": "/v2/private_domains/3fd5eeee-7e92-4898-93b5-85e06a9ed5da/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 70eb848a-0b7e-43f4-a3ef-e15354ee2059
Content-Length: 2483
X-Content-Type-Options: nosniff