Retrieve Domain

To retrieve a domain, perform a GET request.

Endpoint

Use the following endpoint to retrieve a domain: https://iam.ionos.com/federation/domains/{domainId}.

Request

Note: The following request contains a sample domainId. Replace it with the domainId value, whose information you want to retrieve.

curl --X \  
--request GET 'https://iam.ionos.com/federation/domains/f181c212-34f1-5843-9bbb-fc2531c7d928' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO' \
--header 'Content-Type: application/json' \

Path Parameters

Below is the list of mandatory path parameter:

Body Parameters	Type	Description	Example
domainId	string	The ID (UUID) of the domain.	f181c212-34f1-5843-9bbb-fc2531c7d928

Request Header Parameters

To make authenticated requests to the API, the following fields are mandatory in the request header:

Header Parameters	Required	Type	Description
Authorization	yes	string	The Bearer token enables requests to authenticate using a JSON Web Token (JWT). From the DCD, Generate authentication token.
Content-Type	yes	string	Set this to application/json.

Response

200 Successful operation

{
   "id":"f181c212-34f1-5843-9bbb-fc2531c7d928",
   "type":"domain",
   "href":"/domains/f181c212-34f1-5843-9bbb-fc2531c7d928",
   "metadata":{
      "createdDate":"2020-12-10T13:37:50+01:00",
      "createdBy":"ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
      "createdByUserId":"87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
      "lastModifiedDate":"2020-12-11T13:37:50+01:00",
      "lastModifiedBy":"ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
      "lastModifiedByUserId":"87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
      "resourceURN":"ionos:<product>:<location>:<contract>:<resource-path>",
      "account":123456
   },
   "properties":{
      "domain":"yourcompany.com",
      "status":"REQUESTED",
      "message":"The token provided should be added to the TXT Domain Record, then request to verify the ownership. Important: This is the only time the token will be visible to you, so please take note of it now."
   }
}