• Register

Unique Public Fully Qualified Domain Names

Resource URI

/domains/public/hostnames

Items in curly braces represent variables.

Description

Collection of unique Public fully qualified domain names.

Resource Schema

Property Characteristics
address Type string
Sub-type
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Fully qualified domain name.

fetch [GET]

Retrieves collection of all Public Domains belonging to the given Area

Parameters

Parameter Required Type Description
domainPrefix true object domainPrefix that matches the retrieved Public Domain Endpoint domain
fields false string Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter false string Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort false string Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\|desc)\]>\[,...\]\[&sort=...\]
limit false int Number of objects to return in the result. Defaults to 100.
offset false int 0-based index of first object in the list to return. Defaults to 0.
indent false boolean When set to true, responses are indented for better readability.

Returns

Success

Array of Domains for the Area If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/domains/public/hostnames' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "address": "lobortis vel dapibus at"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/domains/public/hostnames' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "address": "sodales sed tincidunt eu"
    }
]

Docs Navigation