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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NCIsImVtYWlsIjoiZW1haWwtMTE3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxMzd9.cZPi9j7rwajpTw8t65t8zSFOo-ASYqP1cUsjO9KN5cs
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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NCIsImVtYWlsIjoiZW1haWwtMTE3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxMzd9.cZPi9j7rwajpTw8t65t8zSFOo-ASYqP1cUsjO9KN5cs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7b44c02f-45fe-4150-b472-1d71881d59fb
Content-Length: 1691
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 5,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "5797fc6e-a407-4319-bc0a-d1940644793c",
        "url": "/v2/shared_domains/5797fc6e-a407-4319-bc0a-d1940644793c",
        "created_at": "2014-11-05T01:02:07+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "b82eaf13-0808-4e72-843b-da10ee262e3b",
        "url": "/v2/shared_domains/b82eaf13-0808-4e72-843b-da10ee262e3b",
        "created_at": "2014-11-05T01:02:07+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "4e68cfcd-5cf1-4461-b423-3f0f5c17c08f",
        "url": "/v2/shared_domains/4e68cfcd-5cf1-4461-b423-3f0f5c17c08f",
        "created_at": "2014-11-05T01:02:17+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-16.example.com"
      }
    },
    {
      "metadata": {
        "guid": "7fe1ef0e-2713-471d-ba78-669f26f29915",
        "url": "/v2/shared_domains/7fe1ef0e-2713-471d-ba78-669f26f29915",
        "created_at": "2014-11-05T01:02:17+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-17.example.com"
      }
    },
    {
      "metadata": {
        "guid": "18679806-0326-4216-8965-8d5130ad9bb7",
        "url": "/v2/shared_domains/18679806-0326-4216-8965-8d5130ad9bb7",
        "created_at": "2014-11-05T01:02:17+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-18.example.com"
      }
    }
  ]
}