Retrieve all Domains

To retrieve all domains, perform a GET request.

Endpoint

Use the following endpoint to retrieve an IDP: https://iam.ionos.com/federation/domains.

Request

curl --X \  
--request GET 'https://iam.ionos.com/federation/domains \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO' \
--header 'Content-Type: application/json' \

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": "7d4a3d9d-033d-5794-99e6-d5cfa9516fc4",
  "type": "collection",
  "href": "/domains",
  "items":[
    {
      "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."
      }
    }
  ]
}

Last updated

Was this helpful?