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.eyJ1c2VyX2lkIjoidWFhLWlkLTM3IiwiZW1haWwiOiJlbWFpbC0zN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYwNTA2NjM4fQ.5f8ULsAm1HeJR-O5grHHSD9I9ibWm4uYvTBeN_fepsI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3IiwiZW1haWwiOiJlbWFpbC0zN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYwNTA2NjM4fQ.5f8ULsAm1HeJR-O5grHHSD9I9ibWm4uYvTBeN_fepsI" \
	-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": "dc138d35-a6cb-45e7-b8eb-db1d82309ae3",
        "url": "/v2/private_domains/dc138d35-a6cb-45e7-b8eb-db1d82309ae3",
        "created_at": "2016-04-06T00:17:18Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "9d6ce600-424a-442c-a7ea-2d3f72d49806",
        "owning_organization_url": "/v2/organizations/9d6ce600-424a-442c-a7ea-2d3f72d49806",
        "shared_organizations_url": "/v2/private_domains/dc138d35-a6cb-45e7-b8eb-db1d82309ae3/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "1baa6f30-ebfd-4c32-9ec5-cd266f31535b",
        "url": "/v2/private_domains/1baa6f30-ebfd-4c32-9ec5-cd266f31535b",
        "created_at": "2016-04-06T00:17:18Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-10.example.com",
        "owning_organization_guid": "a587ac9f-99c6-4986-9819-cf75e157ee04",
        "owning_organization_url": "/v2/organizations/a587ac9f-99c6-4986-9819-cf75e157ee04",
        "shared_organizations_url": "/v2/private_domains/1baa6f30-ebfd-4c32-9ec5-cd266f31535b/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "432921f2-582c-4859-937a-382426ca33f7",
        "url": "/v2/private_domains/432921f2-582c-4859-937a-382426ca33f7",
        "created_at": "2016-04-06T00:17:18Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-11.example.com",
        "owning_organization_guid": "f2181fb5-8f1c-4183-b335-af325d3ed4e1",
        "owning_organization_url": "/v2/organizations/f2181fb5-8f1c-4183-b335-af325d3ed4e1",
        "shared_organizations_url": "/v2/private_domains/432921f2-582c-4859-937a-382426ca33f7/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "34556ed9-84bc-4907-a157-230eb0605c08",
        "url": "/v2/private_domains/34556ed9-84bc-4907-a157-230eb0605c08",
        "created_at": "2016-04-06T00:17:18Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-12.example.com",
        "owning_organization_guid": "ffa03d4b-49db-4b2b-868b-eae8d8aab8ac",
        "owning_organization_url": "/v2/organizations/ffa03d4b-49db-4b2b-868b-eae8d8aab8ac",
        "shared_organizations_url": "/v2/private_domains/34556ed9-84bc-4907-a157-230eb0605c08/shared_organizations"
      }
    }
  ]
}

Headers

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