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.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NSIsImVtYWlsIjoiZW1haWwtMjA2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTY0NTIyMzl9.004WQk0JnyLq8e5E_goaiatFPpgENt990SSkcjaBu1Q
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NSIsImVtYWlsIjoiZW1haWwtMjA2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTY0NTIyMzl9.004WQk0JnyLq8e5E_goaiatFPpgENt990SSkcjaBu1Q" \
	-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": "cab24f65-5531-43a5-b50d-9c178e69e6b8",
        "url": "/v2/private_domains/cab24f65-5531-43a5-b50d-9c178e69e6b8",
        "created_at": "2016-02-19T02:03:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "dbc9862e-6e71-4bb8-a768-8d6597b5bd89",
        "owning_organization_url": "/v2/organizations/dbc9862e-6e71-4bb8-a768-8d6597b5bd89",
        "shared_organizations_url": "/v2/private_domains/cab24f65-5531-43a5-b50d-9c178e69e6b8/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "e4f42087-c02e-45ce-b96d-d97235d1e1ef",
        "url": "/v2/private_domains/e4f42087-c02e-45ce-b96d-d97235d1e1ef",
        "created_at": "2016-02-19T02:03:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-32.example.com",
        "owning_organization_guid": "c112e629-dd2e-4cd2-a43a-b97b1bfee2f6",
        "owning_organization_url": "/v2/organizations/c112e629-dd2e-4cd2-a43a-b97b1bfee2f6",
        "shared_organizations_url": "/v2/private_domains/e4f42087-c02e-45ce-b96d-d97235d1e1ef/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "8e97bd1c-1191-4e0a-84b0-b25b745c7b54",
        "url": "/v2/private_domains/8e97bd1c-1191-4e0a-84b0-b25b745c7b54",
        "created_at": "2016-02-19T02:03:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-33.example.com",
        "owning_organization_guid": "06165653-9e1d-4a92-850f-b06918e4b83e",
        "owning_organization_url": "/v2/organizations/06165653-9e1d-4a92-850f-b06918e4b83e",
        "shared_organizations_url": "/v2/private_domains/8e97bd1c-1191-4e0a-84b0-b25b745c7b54/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "c4a0ab99-0f53-4b76-bd34-b7f9b04d9d02",
        "url": "/v2/private_domains/c4a0ab99-0f53-4b76-bd34-b7f9b04d9d02",
        "created_at": "2016-02-19T02:03:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-34.example.com",
        "owning_organization_guid": "7291787c-c28f-480e-8790-45e25c5a2bdb",
        "owning_organization_url": "/v2/organizations/7291787c-c28f-480e-8790-45e25c5a2bdb",
        "shared_organizations_url": "/v2/private_domains/c4a0ab99-0f53-4b76-bd34-b7f9b04d9d02/shared_organizations"
      }
    }
  ]
}

Headers

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