Home
Version 3
Shared Domains API

Shared Domains API

List all Shared Domains

GET /v2/shared_domains

Fields

Name Description Default Valid Values Example Values
guid The guid of the domain.
name The name of the domain.
  • example.com
  • foo.example.com

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwOSIsImVtYWlsIjoiZW1haWwtODBAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDMxMDEyNX0.86eJTb7gB5SbJyHBDkXbVTECVKMD_XRRWeikH3iMiCs
Host: example.org
Cookie: 

Route

GET /v2/shared_domains

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwOSIsImVtYWlsIjoiZW1haWwtODBAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDMxMDEyNX0.86eJTb7gB5SbJyHBDkXbVTECVKMD_XRRWeikH3iMiCs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: fc015673-1297-4879-90c1-c58765470a46
Content-Length: 1663
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 5,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "054589ff-c26a-4c8a-aebd-7052f6bc6537",
        "url": "/v2/shared_domains/054589ff-c26a-4c8a-aebd-7052f6bc6537",
        "created_at": "2015-02-12T01:41:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "1cf25959-176a-4853-baac-9b6014e7e9e7",
        "url": "/v2/shared_domains/1cf25959-176a-4853-baac-9b6014e7e9e7",
        "created_at": "2015-02-12T01:41:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "cc629b16-0b60-41ce-bd90-eea9b6710e79",
        "url": "/v2/shared_domains/cc629b16-0b60-41ce-bd90-eea9b6710e79",
        "created_at": "2015-02-12T01:42:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-4.example.com"
      }
    },
    {
      "metadata": {
        "guid": "5db7b273-8580-4e55-a31a-cf5e328880f6",
        "url": "/v2/shared_domains/5db7b273-8580-4e55-a31a-cf5e328880f6",
        "created_at": "2015-02-12T01:42:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-5.example.com"
      }
    },
    {
      "metadata": {
        "guid": "0e79ac93-72d9-4668-8cc0-ca8541e40b63",
        "url": "/v2/shared_domains/0e79ac93-72d9-4668-8cc0-ca8541e40b63",
        "created_at": "2015-02-12T01:42:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-6.example.com"
      }
    }
  ]
}