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.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NCIsImVtYWlsIjoiZW1haWwtMTM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDV9.ldHDp7TaBWViKGkGRwAL4tZON8a_Bk7ujZ-D5KKrHGQ
Host: example.org
Cookie: 

Route

GET /v2/organizations/0cb015b8-99d2-45a4-b06c-2d145b1dfc00/private_domains

cURL

curl "https://api.[your-domain.com]/v2/organizations/0cb015b8-99d2-45a4-b06c-2d145b1dfc00/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NCIsImVtYWlsIjoiZW1haWwtMTM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDV9.ldHDp7TaBWViKGkGRwAL4tZON8a_Bk7ujZ-D5KKrHGQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ccbec777-790f-4403-967b-19fefa74760b
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": "bb7f74da-2992-4d13-b110-87cafd4e95ad",
        "url": "/v2/private_domains/bb7f74da-2992-4d13-b110-87cafd4e95ad",
        "created_at": "2014-11-13T23:38:25+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-39.example.com",
        "owning_organization_guid": "0cb015b8-99d2-45a4-b06c-2d145b1dfc00",
        "owning_organization_url": "/v2/organizations/0cb015b8-99d2-45a4-b06c-2d145b1dfc00"
      }
    }
  ]
}