Home
Version 3
Organizations API

Organizations API

List all Domains for the Organization (deprecated)

GET /v2/organizations/:guid/domains

Request

Route

GET /v2/organizations/f72f59cb-5675-42c0-b56e-1a5bdead7675/domains

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, owning_organization_guid
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTkxIiwiZW1haWwiOiJlbWFpbC02MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYzNjE4NzA2fQ.mDn4ejf8RDj4AVm-CNexkD2oeWIjGhjzMyIykeVlTe0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/f72f59cb-5675-42c0-b56e-1a5bdead7675/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTkxIiwiZW1haWwiOiJlbWFpbC02MkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYzNjE4NzA2fQ.mDn4ejf8RDj4AVm-CNexkD2oeWIjGhjzMyIykeVlTe0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "0b84cdf8-3e5e-40e7-b720-a79660db05ea",
        "url": "/v2/domains/0b84cdf8-3e5e-40e7-b720-a79660db05ea",
        "created_at": "2016-05-12T00:45:03Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "8fdf9817-66cf-474a-96c8-a70a86c7eb08",
        "url": "/v2/domains/8fdf9817-66cf-474a-96c8-a70a86c7eb08",
        "created_at": "2016-05-12T00:45:03Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a2706776-aad5-4edb-a98a-f7aa9b792379
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 859
X-Content-Type-Options: nosniff