Home
Version 3
Organizations API

Organizations API

List all Domains for the Organization (deprecated)

GET /v2/organizations/:guid/domains

Request

Route

GET /v2/organizations/f5f9d02d-8879-4de7-9345-b38adbf0cec2/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, space_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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExNSIsImVtYWlsIjoiZW1haWwtOTRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjYzMzkwMX0.RvLEoC2Y61KS3bOyXd-e-DaggsGPPRAF8K9d49p4fsU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/f5f9d02d-8879-4de7-9345-b38adbf0cec2/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExNSIsImVtYWlsIjoiZW1haWwtOTRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjYzMzkwMX0.RvLEoC2Y61KS3bOyXd-e-DaggsGPPRAF8K9d49p4fsU" \
	-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": "a424a340-cff7-4246-9770-a223ff97314e",
        "url": "/v2/domains/a424a340-cff7-4246-9770-a223ff97314e",
        "created_at": "2015-03-10T23:11:30Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "a087af48-7883-4210-8228-4ebf8d8d9089",
        "url": "/v2/domains/a087af48-7883-4210-8228-4ebf8d8d9089",
        "created_at": "2015-03-10T23:11:30Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3ec1d2d0-5174-41af-a904-8a5f77f46d88
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 719
X-Content-Type-Options: nosniff