Views:

Queries all domains associated with your licensed account.

HTTP Request

GET https://<serviceURL>/api/v1/domains

Request Parameters

None.

HTTP Request Example

GET https://<serviceURL>/api/v1/domains HTTP/1.1
Authorization: Basic c2FtcGxlOmZqZmo0OTBpNGpnaDAzM2dsajQzYXB3ZW1hMzEwdjEwamIxZ2lrM2oz
Accept-Encoding: gzip

Response

On success, the service sends back an HTTP 200 response and returns a response body in JSON format; otherwise, the response body contains error details. For more information about errors, see API Response Codes.

Status Code

Description

200

Successful.

The domains are returned in the response body.

The response body is an array of domain objects in JSON format.

Response Example

HTTP/1.1 200
Content-Encoding: gzip
Content-Type: application/json;charset=utf-8
 
[
    {
        "name": "sample1.com"
    },
    {
        "name": "sample2.com"
    }
]

Response Parameters

Name

Type

Description

name

String

Name of a domain object.