Home
Version 3
Private Domains API

Private Domains API

List all Private Domains

GET /v2/private_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
owning_organization_guid The organization that owns the domain. If not specified, the domain is shared.

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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MiIsImVtYWlsIjoiZW1haWwtMTE0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzB9.wyGz-KKWlWXT5A6WgS4HGgZNTFJia6MqZGtyAYPIsDA
Host: example.org
Cookie: 

Route

GET /v2/private_domains

cURL

curl "https://api.[your-domain.com]/v2/private_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MiIsImVtYWlsIjoiZW1haWwtMTE0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzB9.wyGz-KKWlWXT5A6WgS4HGgZNTFJia6MqZGtyAYPIsDA" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ae389785-3538-4142-a795-152da39a40b4
Content-Length: 2035
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 4,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "b73e8a9e-c7b8-4a8d-9c6b-2a43a649937f",
        "url": "/v2/private_domains/b73e8a9e-c7b8-4a8d-9c6b-2a43a649937f",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "0aa53a0e-e737-49d4-9880-62d4eb4b7b61",
        "owning_organization_url": "/v2/organizations/0aa53a0e-e737-49d4-9880-62d4eb4b7b61"
      }
    },
    {
      "metadata": {
        "guid": "89dbb170-f9f2-42f0-8616-0333b8fc2550",
        "url": "/v2/private_domains/89dbb170-f9f2-42f0-8616-0333b8fc2550",
        "created_at": "2014-12-24T01:39:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-30.example.com",
        "owning_organization_guid": "eddba272-739a-4d19-b96a-f30b90b2ee8f",
        "owning_organization_url": "/v2/organizations/eddba272-739a-4d19-b96a-f30b90b2ee8f"
      }
    },
    {
      "metadata": {
        "guid": "34b50859-976f-42fc-8c00-c5b24d6515ff",
        "url": "/v2/private_domains/34b50859-976f-42fc-8c00-c5b24d6515ff",
        "created_at": "2014-12-24T01:39:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-31.example.com",
        "owning_organization_guid": "55cae976-bae4-40d2-b5d8-f895d3cd4ee2",
        "owning_organization_url": "/v2/organizations/55cae976-bae4-40d2-b5d8-f895d3cd4ee2"
      }
    },
    {
      "metadata": {
        "guid": "4e3be410-bc3c-48d0-8c12-87de3d78f9a0",
        "url": "/v2/private_domains/4e3be410-bc3c-48d0-8c12-87de3d78f9a0",
        "created_at": "2014-12-24T01:39:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-32.example.com",
        "owning_organization_guid": "59740b1f-bec1-4546-af5b-7df1eaa42ddb",
        "owning_organization_url": "/v2/organizations/59740b1f-bec1-4546-af5b-7df1eaa42ddb"
      }
    }
  ]
}