AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

APIGateways

An API gateway consists of the generic rules and configurations of an API Gateway.

This tag groups all operations for apigateways.

Retrieve all APIGateways

get

This endpoint enables retrieving all APIGateways using pagination and optional filters.

Authorizations
Query parameters
offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

Default: 0Example: 0
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with offset for pagination.

Default: 100Example: 100
orderBystring · enumOptional

The field to order the results by. If not provided, the results will be ordered by the default field.

Default: -createdDatePossible values:
Responses
200
Returned all requested APIGateways successfully.
application/json
Responseall of
and
get
GET /gateways HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "274004e3-6f41-5468-862f-64a7b3445c18",
  "type": "collection",
  "href": "/gateways",
  "items": [
    {
      "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": "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>",
        "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"
          }
        ],
        "cache": {
          "enable": true,
          "httpMethods": [
            "GET"
          ],
          "httpCodes": [
            200
          ],
          "override": false
        }
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create Gateway

post

Creates a new Gateway.

The full Gateway needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations
Body
metadataanyOptional

Metadata

Responses
201
Gateway successfully created.
application/json
post
POST /gateways HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "metadata": {},
  "properties": {
    "name": "APIGateway-1",
    "logs": false,
    "metrics": false,
    "customDomains": [
      {
        "name": "api.example.com",
        "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
      }
    ],
    "cache": {
      "enable": true,
      "httpMethods": [
        "GET"
      ],
      "httpCodes": [
        200
      ],
      "override": false
    }
  }
}
{
  "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": "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>",
    "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"
      }
    ],
    "cache": {
      "enable": true,
      "httpMethods": [
        "GET"
      ],
      "httpCodes": [
        200
      ],
      "override": false
    }
  }
}

Retrieve Gateway

get

Returns the Gateway by ID.

Authorizations
Path parameters
apigatewayIdstring · uuidRequired

The ID (UUID) of the Gateway.

Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00
Responses
200
Getting Gateway was successful.
application/json
get
GET /gateways/{apigatewayId} HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "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": "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>",
    "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"
      }
    ],
    "cache": {
      "enable": true,
      "httpMethods": [
        "GET"
      ],
      "httpCodes": [
        200
      ],
      "override": false
    }
  }
}

Ensure Gateway

put

Ensures that the Gateway with the provided ID is created or modified. The full Gateway needs to be provided to ensure (either update or create) the Gateway. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations
Path parameters
apigatewayIdstring · uuidRequired

The ID (UUID) of the Gateway.

Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00
Body
idstring · uuidRequired

The ID (UUID) of the Gateway.

Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00
metadataanyOptional

Metadata

Responses
200
Gateway successfully updated.
application/json
put
PUT /gateways/{apigatewayId} HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "id": "0620c174-dd3c-5eb4-87c8-e2b516553a00",
  "metadata": {},
  "properties": {
    "name": "APIGateway-1",
    "logs": false,
    "metrics": false,
    "customDomains": [
      {
        "name": "api.example.com",
        "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
      }
    ],
    "cache": {
      "enable": true,
      "httpMethods": [
        "GET"
      ],
      "httpCodes": [
        200
      ],
      "override": false
    }
  }
}
{
  "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": "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>",
    "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"
      }
    ],
    "cache": {
      "enable": true,
      "httpMethods": [
        "GET"
      ],
      "httpCodes": [
        200
      ],
      "override": false
    }
  }
}

Delete Gateway

delete

Deletes the specified Gateway.

Authorizations
Path parameters
apigatewayIdstring · uuidRequired

The ID (UUID) of the Gateway.

Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00
Responses
202
Deleting Gateway was successful.
delete
DELETE /gateways/{apigatewayId} HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer JWT
Accept: */*

No content
PreviousAPI GatewayNextRoutes

Was this helpful?