Central

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

This tag groups all operations for central.

Retrieve all CentralLogging

get

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

Authorizations

Responses

200

Returned all requested CentralLogging successfully.

application/json

Responseall of

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

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

{
  "id": "d9a741e7-1132-5b47-94d3-aabefa619c91",
  "type": "collection",
  "href": "/central",
  "items": [
    {
      "id": "40740a56-ee77-5bff-8abc-2dda26b3144f",
      "type": "centrallogging",
      "href": "/central/40740a56-ee77-5bff-8abc-2dda26b3144f",
      "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 CentralLogging

get

Returns the CentralLogging by ID.

Authorizations

Path parameters

centralIdstring · uuidRequired

The ID (UUID) of the CentralLogging.

Example: 40740a56-ee77-5bff-8abc-2dda26b3144f

Responses

200

Getting CentralLogging was successful.

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

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

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

{
  "id": "40740a56-ee77-5bff-8abc-2dda26b3144f",
  "type": "centrallogging",
  "href": "/central/40740a56-ee77-5bff-8abc-2dda26b3144f",
  "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 CentralLogging

put

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

Authorizations

Path parameters

centralIdstring · uuidRequired

The ID (UUID) of the CentralLogging.

Example: 40740a56-ee77-5bff-8abc-2dda26b3144f

Body

metadataanyOptional

Metadata

Responses

200

CentralLogging successfully updated.

application/json

201

CentralLogging 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

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

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

{
  "id": "40740a56-ee77-5bff-8abc-2dda26b3144f",
  "type": "centrallogging",
  "href": "/central/40740a56-ee77-5bff-8abc-2dda26b3144f",
  "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
  }
}

PreviousKey NextModels

Was this helpful?