Central

Central monitoring is a feature that allows you to use other products to send metrics to a central location. This is useful for analyzing metrics from multiple sources.

This tag groups all operations for central.

Retrieve all CentralMonitoring

get

https://monitoring.de-fra.ionos.comhttps://monitoring.de-txl.ionos.comhttps://monitoring.es-vit.ionos.comhttps://monitoring.gb-bhx.ionos.comhttps://monitoring.gb-lhr.ionos.comhttps://monitoring.fr-par.ionos.comhttps://monitoring.us-mci.ionos.comhttps://monitoring.us-ewr.ionos.comhttps://monitoring.us-las.ionos.com

/central

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

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Responses

200

Returned all requested CentralMonitoring successfully.

application/json

idstring · uuidRequired

ID of the list of CentralMonitoring resources.

Example: d9a741e7-1132-5b47-94d3-aabefa619c91

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the list of CentralMonitoring resources.

Example: /central

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

/central

HTTPcURLJavaScriptPython

GET /central HTTP/1.1
Host: monitoring.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "d9a741e7-1132-5b47-94d3-aabefa619c91",
  "type": "collection",
  "href": "/central",
  "items": [
    {
      "id": "23e6183d-6ab3-54de-b165-9b44c3589f4f",
      "type": "centralmonitoring",
      "href": "/central/23e6183d-6ab3-54de-b165-9b44c3589f4f",
      "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>",
        "grafanaEndpoint": "https://grafana.logging.de-txl.ionos.com",
        "products": [
          "api-gateway",
          "alb"
        ]
      },
      "properties": {
        "enabled": false
      }
    }
  ]
}

Retrieve CentralMonitoring

get

https://monitoring.de-fra.ionos.comhttps://monitoring.de-txl.ionos.comhttps://monitoring.es-vit.ionos.comhttps://monitoring.gb-bhx.ionos.comhttps://monitoring.gb-lhr.ionos.comhttps://monitoring.fr-par.ionos.comhttps://monitoring.us-mci.ionos.comhttps://monitoring.us-ewr.ionos.comhttps://monitoring.us-las.ionos.com

/central/{centralId}

Returns the CentralMonitoring by ID.

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

centralIdstring · uuidRequired

The ID (UUID) of the CentralMonitoring.

Example: 23e6183d-6ab3-54de-b165-9b44c3589f4f

Responses

200

Getting CentralMonitoring was successful.

application/json

idstring · uuidRequired

The ID (UUID) of the CentralMonitoring.

Example: 23e6183d-6ab3-54de-b165-9b44c3589f4f

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the CentralMonitoring.

Example: /central/23e6183d-6ab3-54de-b165-9b44c3589f4f

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

/central/{centralId}

HTTPcURLJavaScriptPython

GET /central/{centralId} HTTP/1.1
Host: monitoring.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "23e6183d-6ab3-54de-b165-9b44c3589f4f",
  "type": "centralmonitoring",
  "href": "/central/23e6183d-6ab3-54de-b165-9b44c3589f4f",
  "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>",
    "grafanaEndpoint": "https://grafana.logging.de-txl.ionos.com",
    "products": [
      "api-gateway",
      "alb"
    ]
  },
  "properties": {
    "enabled": false
  }
}

Ensure CentralMonitoring

put

https://monitoring.de-fra.ionos.comhttps://monitoring.de-txl.ionos.comhttps://monitoring.es-vit.ionos.comhttps://monitoring.gb-bhx.ionos.comhttps://monitoring.gb-lhr.ionos.comhttps://monitoring.fr-par.ionos.comhttps://monitoring.us-mci.ionos.comhttps://monitoring.us-ewr.ionos.comhttps://monitoring.us-las.ionos.com

/central/{centralId}

Ensures that the CentralMonitoring with the provided ID is created or modified. The full CentralMonitoring needs to be provided to ensure (either update or create) the CentralMonitoring. 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

centralIdstring · uuidRequired

The ID (UUID) of the CentralMonitoring.

Example: 23e6183d-6ab3-54de-b165-9b44c3589f4f

Body

application/json

metadataanyOptional

Metadata

Responses

200

CentralMonitoring successfully updated.

application/json

idstring · uuidRequired

The ID (UUID) of the CentralMonitoring.

Example: 23e6183d-6ab3-54de-b165-9b44c3589f4f

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the CentralMonitoring.

Example: /central/23e6183d-6ab3-54de-b165-9b44c3589f4f

201

CentralMonitoring 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

/central/{centralId}

HTTPcURLJavaScriptPython

PUT /central/{centralId} HTTP/1.1
Host: monitoring.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "metadata": {},
  "properties": {
    "enabled": false
  }
}

{
  "id": "23e6183d-6ab3-54de-b165-9b44c3589f4f",
  "type": "centralmonitoring",
  "href": "/central/23e6183d-6ab3-54de-b165-9b44c3589f4f",
  "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>",
    "grafanaEndpoint": "https://grafana.logging.de-txl.ionos.com",
    "products": [
      "api-gateway",
      "alb"
    ]
  },
  "properties": {
    "enabled": false
  }
}