Home
Version 3
Organizations API

Organizations API

List all Private Domains for the Organization

GET /v2/organizations/:guid/private_domains

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization
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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NCIsImVtYWlsIjoiZW1haWwtMjEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzZ9.UW2trzZmemP4ctT7Divyw17NUxVxn-71cooa9DN07Yo
Host: example.org
Cookie: 

Route

GET /v2/organizations/1b7485d9-91e7-4cfd-9e4e-6f67c103279e/private_domains

cURL

curl "https://api.[your-domain.com]/v2/organizations/1b7485d9-91e7-4cfd-9e4e-6f67c103279e/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NCIsImVtYWlsIjoiZW1haWwtMjEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzZ9.UW2trzZmemP4ctT7Divyw17NUxVxn-71cooa9DN07Yo" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a7987a61-4952-40d4-8b8c-f0897133fd5e
Content-Length: 591
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "6c009934-8b1e-4074-8356-9907272f2d5f",
        "url": "/v2/private_domains/6c009934-8b1e-4074-8356-9907272f2d5f",
        "created_at": "2014-12-24T01:39:36+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-55.example.com",
        "owning_organization_guid": "1b7485d9-91e7-4cfd-9e4e-6f67c103279e",
        "owning_organization_url": "/v2/organizations/1b7485d9-91e7-4cfd-9e4e-6f67c103279e"
      }
    }
  ]
}