Unique System Fully Qualified Domain Names
Resource URI
/domains/system/hostnames
Items in curly braces represent variables.
Description
Collection of unique System 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 System 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 System 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/system/hostnames' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"
Response
[ { "address": "nisl duis ac nibh" } ]
Request
curl -k 'https://api.mashery.com/v3/rest/domains/system/hostnames' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"
Response
[ { "address": "lobortis ligula sit" } ]
Docs Navigation
- API Documentation Portal
- IO Docs Definition
- Mashery API Documentation
- Mashery 3.0 API Guide
- Mashery 2.0 API Guide
- OAuth Supporting Methods
- Examples
- JSON RPC
- Authentication
- API Objects
- Fetching Objects
- Query Language
- Creating Objects
- Updating Objects
- Validating Fields
- Deleting Objects
- Applications
- General Object Methods
- Members
- Packages
- Plans
- Package Keys
- Keys
- Developer Classes
- Services
- Roles
- Mashery 2.0 Reporting API Guide
- Event Trigger API
- Differences between Roles and Portal Access Groups
- Managing a Portal Access Group Using Mashery V2 or V3 API
- Mashery Reporting Event Post API Guide
- Tips and Tricks
- Your Portal
- API Traffic Manager
- I/O Docs WSDL requirements