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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzIiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyMzEzNjA1fQ.4a6zZLkDqQWH1_i3NXPOUjq0tmihQKKmD_yMwV3A12k
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzIiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyMzEzNjA1fQ.4a6zZLkDqQWH1_i3NXPOUjq0tmihQKKmD_yMwV3A12k" \
	-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": "4f969d95-26a3-416c-a86b-b1720d764595",
        "url": "/v2/private_domains/4f969d95-26a3-416c-a86b-b1720d764595",
        "created_at": "2015-05-15T16:53:22Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "4055bd51-e5c5-4935-87d4-a28cba12f221",
        "owning_organization_url": "/v2/organizations/4055bd51-e5c5-4935-87d4-a28cba12f221",
        "shared_organizations_url": "/v2/private_domains/4f969d95-26a3-416c-a86b-b1720d764595/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "9ebe9107-1e97-4e5f-b297-4fece638e3fc",
        "url": "/v2/private_domains/9ebe9107-1e97-4e5f-b297-4fece638e3fc",
        "created_at": "2015-05-15T16:53:25Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-25.example.com",
        "owning_organization_guid": "3e3527a8-7003-4245-b207-5f0c2cca2f64",
        "owning_organization_url": "/v2/organizations/3e3527a8-7003-4245-b207-5f0c2cca2f64",
        "shared_organizations_url": "/v2/private_domains/9ebe9107-1e97-4e5f-b297-4fece638e3fc/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "b4817380-064a-43ef-b194-8b1cd44758c7",
        "url": "/v2/private_domains/b4817380-064a-43ef-b194-8b1cd44758c7",
        "created_at": "2015-05-15T16:53:25Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-26.example.com",
        "owning_organization_guid": "cd63fee3-220f-4555-ab9a-65d34a4ff6ee",
        "owning_organization_url": "/v2/organizations/cd63fee3-220f-4555-ab9a-65d34a4ff6ee",
        "shared_organizations_url": "/v2/private_domains/b4817380-064a-43ef-b194-8b1cd44758c7/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "a7b4fd46-44e8-4b8c-aeb1-056c5aa552df",
        "url": "/v2/private_domains/a7b4fd46-44e8-4b8c-aeb1-056c5aa552df",
        "created_at": "2015-05-15T16:53:25Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-27.example.com",
        "owning_organization_guid": "4d889da9-41e6-44aa-8a4a-9bc2d7765ffb",
        "owning_organization_url": "/v2/organizations/4d889da9-41e6-44aa-8a4a-9bc2d7765ffb",
        "shared_organizations_url": "/v2/private_domains/a7b4fd46-44e8-4b8c-aeb1-056c5aa552df/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6ddc68be-154d-44b6-9eb4-199303243f60
Content-Length: 2483
X-Content-Type-Options: nosniff