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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MyIsImVtYWlsIjoiZW1haWwtMTkwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NTB9.BGPAzpdieEJ1nvyO2HCHfsJJUSAzgSnyQlvpmySIWRE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MyIsImVtYWlsIjoiZW1haWwtMTkwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NTB9.BGPAzpdieEJ1nvyO2HCHfsJJUSAzgSnyQlvpmySIWRE" \
	-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": "dbc0091f-ccac-4d38-bd5d-493bb5f28507",
        "url": "/v2/private_domains/dbc0091f-ccac-4d38-bd5d-493bb5f28507",
        "created_at": "2015-09-30T23:30:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "ccb6fa53-8cc9-4600-a78f-3e65746c8dcc",
        "owning_organization_url": "/v2/organizations/ccb6fa53-8cc9-4600-a78f-3e65746c8dcc",
        "shared_organizations_url": "/v2/private_domains/dbc0091f-ccac-4d38-bd5d-493bb5f28507/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "417f536d-f0d9-46f8-a093-d43bcbbc6dd3",
        "url": "/v2/private_domains/417f536d-f0d9-46f8-a093-d43bcbbc6dd3",
        "created_at": "2015-09-30T23:30:50Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-28.example.com",
        "owning_organization_guid": "beb66845-ffc8-412b-8094-7f4ac881a256",
        "owning_organization_url": "/v2/organizations/beb66845-ffc8-412b-8094-7f4ac881a256",
        "shared_organizations_url": "/v2/private_domains/417f536d-f0d9-46f8-a093-d43bcbbc6dd3/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "ca0286e4-90a2-4005-a77b-cef5ddf9ca6c",
        "url": "/v2/private_domains/ca0286e4-90a2-4005-a77b-cef5ddf9ca6c",
        "created_at": "2015-09-30T23:30:50Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-29.example.com",
        "owning_organization_guid": "3147be18-c073-45ad-9cac-439adf352898",
        "owning_organization_url": "/v2/organizations/3147be18-c073-45ad-9cac-439adf352898",
        "shared_organizations_url": "/v2/private_domains/ca0286e4-90a2-4005-a77b-cef5ddf9ca6c/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "7f67abfa-cd05-4654-8140-5b2f91f6f330",
        "url": "/v2/private_domains/7f67abfa-cd05-4654-8140-5b2f91f6f330",
        "created_at": "2015-09-30T23:30:50Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-30.example.com",
        "owning_organization_guid": "3fb9671b-e243-45a3-a468-0715b1780224",
        "owning_organization_url": "/v2/organizations/3fb9671b-e243-45a3-a468-0715b1780224",
        "shared_organizations_url": "/v2/private_domains/7f67abfa-cd05-4654-8140-5b2f91f6f330/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e49b2866-7ce6-45e2-8ea3-54a3695f1c7f
Content-Length: 2483
X-Content-Type-Options: nosniff