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

https://apigateway.de-txl.ionos.comhttps://apigateway.gb-lhr.ionos.comhttps://apigateway.fr-par.ionos.comhttps://apigateway.es-vit.ionos.com

/gateways

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

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Query parameters

offsetinteger · int32Optional

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

Default: 0Example: 0

limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use this parameter together with the 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

Pagination information. The offset and limit parameters are used to navigate the list of elements. The _links object contains URLs to navigate the different pages.

idstring · uuidRequired

ID of the list of Gateway resources.

Example: 274004e3-6f41-5468-862f-64a7b3445c18

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the list of Gateway resources.

Example: /gateways

offsetintegerRead-onlyRequired

The offset specified in the request (if none was specified, the default offset is 0).

Example: 0

limitintegerRead-onlyRequired

The limit specified in the request (if none was specified, use the endpoint's default pagination limit).

Example: 42

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/gateways

HTTPcURLJavaScriptPython

GET /gateways HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://apigateway.de-txl.ionos.comhttps://apigateway.gb-lhr.ionos.comhttps://apigateway.fr-par.ionos.comhttps://apigateway.es-vit.ionos.com

/gateways

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

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Body

application/json

metadataanyOptional

Metadata

Responses

201

Gateway successfully created.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

post

/gateways

HTTPcURLJavaScriptPython

POST /gateways HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://apigateway.de-txl.ionos.comhttps://apigateway.gb-lhr.ionos.comhttps://apigateway.fr-par.ionos.comhttps://apigateway.es-vit.ionos.com

/gateways/{apigatewayId}

Returns the Gateway by ID.

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

apigatewayIdstring · uuidRequired

The ID (UUID) of the Gateway.

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

Responses

200

Getting Gateway was successful.

application/json

idstring · uuidRequired

The ID (UUID) of the Gateway.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the Gateway.

Example: /gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/gateways/{apigatewayId}

HTTPcURLJavaScriptPython

GET /gateways/{apigatewayId} HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://apigateway.de-txl.ionos.comhttps://apigateway.gb-lhr.ionos.comhttps://apigateway.fr-par.ionos.comhttps://apigateway.es-vit.ionos.com

/gateways/{apigatewayId}

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

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

apigatewayIdstring · uuidRequired

The ID (UUID) of the Gateway.

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

Body

application/json

idstring · uuidRequired

The ID (UUID) of the Gateway.

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

metadataanyOptional

Metadata

Responses

200

Gateway successfully updated.

application/json

idstring · uuidRequired

The ID (UUID) of the Gateway.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the Gateway.

Example: /gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00

201

Gateway successfully ensured.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

409

Conflict

The UUID is already taken by another party, follow the guides to generate UUIDs uniquely.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

put

/gateways/{apigatewayId}

HTTPcURLJavaScriptPython

PUT /gateways/{apigatewayId} HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://apigateway.de-txl.ionos.comhttps://apigateway.gb-lhr.ionos.comhttps://apigateway.fr-par.ionos.comhttps://apigateway.es-vit.ionos.com

/gateways/{apigatewayId}

Deletes the specified Gateway.

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

apigatewayIdstring · uuidRequired

The ID (UUID) of the Gateway.

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

Responses

202

Deleting Gateway was successful.

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

delete

/gateways/{apigatewayId}

HTTPcURLJavaScriptPython

DELETE /gateways/{apigatewayId} HTTP/1.1
Host: apigateway.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content