Retrieve Gateway

Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.

To retrieve the Gateway, you need to use the following GET request:

GET /gateways/{apigatewayId}

Request

curl -X 'GET' \
  'https://apigateway.de-txl.ionos.com/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00' \
  -H 'accept: application/json'

Response

201 Success

{
  "id": "0620c174-dd3c-5eb4-87c8-e2b516553a00",
  "type": "gateway",
  "href": "/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[e-mail]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "[e-mail]",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "publicEndpoint": "jf8u4tgr73sd-ag.87uhr654gq90.apigateway.de-txl.ionos.com"
  },
  "properties": {
    "name": "APIGateway 1",
    "logs": false,
    "metrics": false,
    "customDomains": [
      {
        "name": "api.example.com",
        "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
      }
    ]
  }
}