> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/api-reference/observability/logging-service/models.md).

# Models

## The PipelineReadList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"PipelineReadList":{"allOf":[{"type":"object","required":["id","type","href"],"properties":{"id":{"description":"ID of the list of Pipeline resources.","type":"string","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["collection"]},"href":{"description":"The URL of the list of Pipeline resources.","type":"string"},"items":{"description":"The list of Pipeline resources.","type":"array","items":{"$ref":"#/components/schemas/PipelineRead"}}}},{"$ref":"#/components/schemas/Pagination"}]},"PipelineRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Pipeline.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["pipeline"]},"href":{"description":"The URL of the Pipeline.","type":"string"},"metadata":{"$ref":"#/components/schemas/MetadataWithStatus"},"properties":{"$ref":"#/components/schemas/Pipeline"}}},"MetadataWithStatus":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"The state of the object. The state can be:\n* `PROVISIONING` - resource is being created.\n* `AVAILABLE` - resource exists and is healthy.\n* `UPDATING` - resource is being updated.\n* `DESTROYING` - delete command was issued, the resource is being deleted.\n* `FAILED` - resource failed, details in `statusMessage`.\n","enum":["PROVISIONING","AVAILABLE","UPDATING","DESTROYING","FAILED"],"readOnly":true},"statusMessage":{"type":"string","nullable":true,"description":"The message of the failure if state is `FAILED`.\n","readOnly":true}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"Pipeline":{"allOf":[{"$ref":"#/components/schemas/PipelineNoAddr"},{"type":"object","properties":{"tcpAddress":{"type":"string","description":"The TCP address of the pipeline. This is the address to which logs are sent using the TCP protocol.\n"},"httpAddress":{"type":"string","description":"The HTTP address of the pipeline. This is the address to which logs are sent using the HTTP protocol.\n"},"grafanaAddress":{"type":"string","description":"The Grafana address is where user can access their logs, create dashboards, and set up alerts.\n"},"resourceTier":{"type":"string","description":"The resource tier of the pipeline. This is used to determine the resources allocated to the pipeline.\n"},"key":{"type":"string","description":"The key is shared once and is used to authenticate the logs sent to the pipeline.\n"}}}]},"PipelineNoAddr":{"type":"object","description":"A pipeline consists of the building blocks of a centralized logging system including supported log agents and log sources and also public endpoints to push and access logs.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be not more that 20 characters long.\n"},"logs":{"type":"array","items":{"required":["source","tag","protocol","destinations"],"type":"object","properties":{"source":{"type":"string","description":"The source of the logs. Could be one of the following: `generic`, `kubernetes`, `docker`, `systemd`.\n"},"tag":{"type":"string","description":"The tag of the logs. Tag represents a short alphanumeric badge (3–20 characters). It must contain only letters and digits, with no special characters or spaces.\n"},"protocol":{"type":"string","description":"The protocol used to send logs. Could be one of the following: `http`, `tcp`, `otlp`.\n","default":"http"},"labels":{"type":"array","description":"Optional custom labels to filter and report logs\n","items":{"type":"string"},"maxItems":3,"minItems":0,"uniqueItems":true},"destinations":{"type":"array","items":{"type":"object","required":["type","retentionInDays"],"properties":{"type":{"type":"string","description":"The type of the destination. Could be one of the following: `loki`.\n","enum":["loki"]},"retentionInDays":{"type":"integer","description":"The retention period of the logs in days. Could be one of the following: 0, 7, 14, 30.\n","enum":[0,7,14,30]}}}}}}}}},"Pagination":{"required":["offset","limit","_links"],"description":"Pagination information. The offset and limit parameters are used to\nnavigate the list of elements. The _links object contains URLs to\nnavigate the different pages.\n","type":"object","properties":{"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true},"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true},"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The PipelineRead object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"PipelineRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Pipeline.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["pipeline"]},"href":{"description":"The URL of the Pipeline.","type":"string"},"metadata":{"$ref":"#/components/schemas/MetadataWithStatus"},"properties":{"$ref":"#/components/schemas/Pipeline"}}},"MetadataWithStatus":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"The state of the object. The state can be:\n* `PROVISIONING` - resource is being created.\n* `AVAILABLE` - resource exists and is healthy.\n* `UPDATING` - resource is being updated.\n* `DESTROYING` - delete command was issued, the resource is being deleted.\n* `FAILED` - resource failed, details in `statusMessage`.\n","enum":["PROVISIONING","AVAILABLE","UPDATING","DESTROYING","FAILED"],"readOnly":true},"statusMessage":{"type":"string","nullable":true,"description":"The message of the failure if state is `FAILED`.\n","readOnly":true}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"Pipeline":{"allOf":[{"$ref":"#/components/schemas/PipelineNoAddr"},{"type":"object","properties":{"tcpAddress":{"type":"string","description":"The TCP address of the pipeline. This is the address to which logs are sent using the TCP protocol.\n"},"httpAddress":{"type":"string","description":"The HTTP address of the pipeline. This is the address to which logs are sent using the HTTP protocol.\n"},"grafanaAddress":{"type":"string","description":"The Grafana address is where user can access their logs, create dashboards, and set up alerts.\n"},"resourceTier":{"type":"string","description":"The resource tier of the pipeline. This is used to determine the resources allocated to the pipeline.\n"},"key":{"type":"string","description":"The key is shared once and is used to authenticate the logs sent to the pipeline.\n"}}}]},"PipelineNoAddr":{"type":"object","description":"A pipeline consists of the building blocks of a centralized logging system including supported log agents and log sources and also public endpoints to push and access logs.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be not more that 20 characters long.\n"},"logs":{"type":"array","items":{"required":["source","tag","protocol","destinations"],"type":"object","properties":{"source":{"type":"string","description":"The source of the logs. Could be one of the following: `generic`, `kubernetes`, `docker`, `systemd`.\n"},"tag":{"type":"string","description":"The tag of the logs. Tag represents a short alphanumeric badge (3–20 characters). It must contain only letters and digits, with no special characters or spaces.\n"},"protocol":{"type":"string","description":"The protocol used to send logs. Could be one of the following: `http`, `tcp`, `otlp`.\n","default":"http"},"labels":{"type":"array","description":"Optional custom labels to filter and report logs\n","items":{"type":"string"},"maxItems":3,"minItems":0,"uniqueItems":true},"destinations":{"type":"array","items":{"type":"object","required":["type","retentionInDays"],"properties":{"type":{"type":"string","description":"The type of the destination. Could be one of the following: `loki`.\n","enum":["loki"]},"retentionInDays":{"type":"integer","description":"The retention period of the logs in days. Could be one of the following: 0, 7, 14, 30.\n","enum":[0,7,14,30]}}}}}}}}}}}}
```

## The PipelinePatch object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"PipelinePatch":{"type":"object","required":["properties"],"properties":{"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/PipelineNoAddr"}}},"PipelineNoAddr":{"type":"object","description":"A pipeline consists of the building blocks of a centralized logging system including supported log agents and log sources and also public endpoints to push and access logs.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be not more that 20 characters long.\n"},"logs":{"type":"array","items":{"required":["source","tag","protocol","destinations"],"type":"object","properties":{"source":{"type":"string","description":"The source of the logs. Could be one of the following: `generic`, `kubernetes`, `docker`, `systemd`.\n"},"tag":{"type":"string","description":"The tag of the logs. Tag represents a short alphanumeric badge (3–20 characters). It must contain only letters and digits, with no special characters or spaces.\n"},"protocol":{"type":"string","description":"The protocol used to send logs. Could be one of the following: `http`, `tcp`, `otlp`.\n","default":"http"},"labels":{"type":"array","description":"Optional custom labels to filter and report logs\n","items":{"type":"string"},"maxItems":3,"minItems":0,"uniqueItems":true},"destinations":{"type":"array","items":{"type":"object","required":["type","retentionInDays"],"properties":{"type":{"type":"string","description":"The type of the destination. Could be one of the following: `loki`.\n","enum":["loki"]},"retentionInDays":{"type":"integer","description":"The retention period of the logs in days. Could be one of the following: 0, 7, 14, 30.\n","enum":[0,7,14,30]}}}}}}}}}}}}
```

## The CentralLoggingReadList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"CentralLoggingReadList":{"allOf":[{"type":"object","required":["id","type","href"],"properties":{"id":{"description":"ID of the list of CentralLogging resources.","type":"string","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["collection"]},"href":{"description":"The URL of the list of CentralLogging resources.","type":"string"},"items":{"description":"The list of CentralLogging resources.","type":"array","items":{"$ref":"#/components/schemas/CentralLoggingRead"}}}}]},"CentralLoggingRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the CentralLogging.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["centrallogging"]},"href":{"description":"The URL of the CentralLogging.","type":"string"},"metadata":{"$ref":"#/components/schemas/MetadataForCentralLogging"},"properties":{"$ref":"#/components/schemas/CentralLogging"}}},"MetadataForCentralLogging":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["grafanaEndpoint"],"properties":{"grafanaEndpoint":{"type":"string","description":"The endpoint of the Grafana instance.\n","readOnly":true},"products":{"type":"array","items":{"type":"string"},"description":"Products with central logging enabled. This is a comma-separated list of product names.\n","readOnly":true}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"CentralLogging":{"type":"object","description":"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.\n","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"The status of the central logging. If `true`, the central logging is enabled. If `false`, the central logging is disabled.\n","default":false}}}}}}
```

## The CentralLoggingRead object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"CentralLoggingRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the CentralLogging.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["centrallogging"]},"href":{"description":"The URL of the CentralLogging.","type":"string"},"metadata":{"$ref":"#/components/schemas/MetadataForCentralLogging"},"properties":{"$ref":"#/components/schemas/CentralLogging"}}},"MetadataForCentralLogging":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["grafanaEndpoint"],"properties":{"grafanaEndpoint":{"type":"string","description":"The endpoint of the Grafana instance.\n","readOnly":true},"products":{"type":"array","items":{"type":"string"},"description":"Products with central logging enabled. This is a comma-separated list of product names.\n","readOnly":true}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"CentralLogging":{"type":"object","description":"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.\n","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"The status of the central logging. If `true`, the central logging is enabled. If `false`, the central logging is disabled.\n","default":false}}}}}}
```

## The CentralLoggingEnsure object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"CentralLoggingEnsure":{"type":"object","required":["properties"],"properties":{"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/CentralLogging"}}},"CentralLogging":{"type":"object","description":"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.\n","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"The status of the central logging. If `true`, the central logging is enabled. If `false`, the central logging is disabled.\n","default":false}}}}}}
```

## The CentralLoggingCreate object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"CentralLoggingCreate":{"type":"object","required":["properties"],"properties":{"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/CentralLogging"}}},"CentralLogging":{"type":"object","description":"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.\n","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"The status of the central logging. If `true`, the central logging is enabled. If `false`, the central logging is disabled.\n","default":false}}}}}}
```

## The Pipeline object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"Pipeline":{"allOf":[{"$ref":"#/components/schemas/PipelineNoAddr"},{"type":"object","properties":{"tcpAddress":{"type":"string","description":"The TCP address of the pipeline. This is the address to which logs are sent using the TCP protocol.\n"},"httpAddress":{"type":"string","description":"The HTTP address of the pipeline. This is the address to which logs are sent using the HTTP protocol.\n"},"grafanaAddress":{"type":"string","description":"The Grafana address is where user can access their logs, create dashboards, and set up alerts.\n"},"resourceTier":{"type":"string","description":"The resource tier of the pipeline. This is used to determine the resources allocated to the pipeline.\n"},"key":{"type":"string","description":"The key is shared once and is used to authenticate the logs sent to the pipeline.\n"}}}]},"PipelineNoAddr":{"type":"object","description":"A pipeline consists of the building blocks of a centralized logging system including supported log agents and log sources and also public endpoints to push and access logs.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be not more that 20 characters long.\n"},"logs":{"type":"array","items":{"required":["source","tag","protocol","destinations"],"type":"object","properties":{"source":{"type":"string","description":"The source of the logs. Could be one of the following: `generic`, `kubernetes`, `docker`, `systemd`.\n"},"tag":{"type":"string","description":"The tag of the logs. Tag represents a short alphanumeric badge (3–20 characters). It must contain only letters and digits, with no special characters or spaces.\n"},"protocol":{"type":"string","description":"The protocol used to send logs. Could be one of the following: `http`, `tcp`, `otlp`.\n","default":"http"},"labels":{"type":"array","description":"Optional custom labels to filter and report logs\n","items":{"type":"string"},"maxItems":3,"minItems":0,"uniqueItems":true},"destinations":{"type":"array","items":{"type":"object","required":["type","retentionInDays"],"properties":{"type":{"type":"string","description":"The type of the destination. Could be one of the following: `loki`.\n","enum":["loki"]},"retentionInDays":{"type":"integer","description":"The retention period of the logs in days. Could be one of the following: 0, 7, 14, 30.\n","enum":[0,7,14,30]}}}}}}}}}}}}
```

## The PipelineNoAddr object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"PipelineNoAddr":{"type":"object","description":"A pipeline consists of the building blocks of a centralized logging system including supported log agents and log sources and also public endpoints to push and access logs.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be not more that 20 characters long.\n"},"logs":{"type":"array","items":{"required":["source","tag","protocol","destinations"],"type":"object","properties":{"source":{"type":"string","description":"The source of the logs. Could be one of the following: `generic`, `kubernetes`, `docker`, `systemd`.\n"},"tag":{"type":"string","description":"The tag of the logs. Tag represents a short alphanumeric badge (3–20 characters). It must contain only letters and digits, with no special characters or spaces.\n"},"protocol":{"type":"string","description":"The protocol used to send logs. Could be one of the following: `http`, `tcp`, `otlp`.\n","default":"http"},"labels":{"type":"array","description":"Optional custom labels to filter and report logs\n","items":{"type":"string"},"maxItems":3,"minItems":0,"uniqueItems":true},"destinations":{"type":"array","items":{"type":"object","required":["type","retentionInDays"],"properties":{"type":{"type":"string","description":"The type of the destination. Could be one of the following: `loki`.\n","enum":["loki"]},"retentionInDays":{"type":"integer","description":"The retention period of the logs in days. Could be one of the following: 0, 7, 14, 30.\n","enum":[0,7,14,30]}}}}}}}}}}}}
```

## The PipelineCreate object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"PipelineCreate":{"type":"object","description":"A pipeline consists of the building blocks of a centralized logging system including supported log agents and log sources and also public endpoints to push and access logs.\n","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/PipelineNoAddr"}}},"PipelineNoAddr":{"type":"object","description":"A pipeline consists of the building blocks of a centralized logging system including supported log agents and log sources and also public endpoints to push and access logs.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be not more that 20 characters long.\n"},"logs":{"type":"array","items":{"required":["source","tag","protocol","destinations"],"type":"object","properties":{"source":{"type":"string","description":"The source of the logs. Could be one of the following: `generic`, `kubernetes`, `docker`, `systemd`.\n"},"tag":{"type":"string","description":"The tag of the logs. Tag represents a short alphanumeric badge (3–20 characters). It must contain only letters and digits, with no special characters or spaces.\n"},"protocol":{"type":"string","description":"The protocol used to send logs. Could be one of the following: `http`, `tcp`, `otlp`.\n","default":"http"},"labels":{"type":"array","description":"Optional custom labels to filter and report logs\n","items":{"type":"string"},"maxItems":3,"minItems":0,"uniqueItems":true},"destinations":{"type":"array","items":{"type":"object","required":["type","retentionInDays"],"properties":{"type":{"type":"string","description":"The type of the destination. Could be one of the following: `loki`.\n","enum":["loki"]},"retentionInDays":{"type":"integer","description":"The retention period of the logs in days. Could be one of the following: 0, 7, 14, 30.\n","enum":[0,7,14,30]}}}}}}}}}}}}
```

## The KeyRead object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"KeyRead":{"type":"object","description":"Generates a new key for a pipeline invalidating the old one. The key is used for authentication when sending logs.\n","required":["key"],"properties":{"key":{"type":"string","description":"The key is shared once and is used to authenticate the logs sent to the pipeline.\n"}}}}}}
```

## The KeyCreate object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"KeyCreate":{"type":"object","description":"Generates a new key for a pipeline invalidating the old one. The key is used for authentication when sending logs.\n"}}}}
```

## The CentralLogging object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"CentralLogging":{"type":"object","description":"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.\n","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"The status of the central logging. If `true`, the central logging is enabled. If `false`, the central logging is disabled.\n","default":false}}}}}}
```

## The MetadataWithStatus object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"MetadataWithStatus":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"The state of the object. The state can be:\n* `PROVISIONING` - resource is being created.\n* `AVAILABLE` - resource exists and is healthy.\n* `UPDATING` - resource is being updated.\n* `DESTROYING` - delete command was issued, the resource is being deleted.\n* `FAILED` - resource failed, details in `statusMessage`.\n","enum":["PROVISIONING","AVAILABLE","UPDATING","DESTROYING","FAILED"],"readOnly":true},"statusMessage":{"type":"string","nullable":true,"description":"The message of the failure if state is `FAILED`.\n","readOnly":true}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}}}}}
```

## The MetadataForCentralLogging object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"MetadataForCentralLogging":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["grafanaEndpoint"],"properties":{"grafanaEndpoint":{"type":"string","description":"The endpoint of the Grafana instance.\n","readOnly":true},"products":{"type":"array","items":{"type":"string"},"description":"Products with central logging enabled. This is a comma-separated list of product names.\n","readOnly":true}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}}}}}
```

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"Error":{"description":"The Error object is used to represent an error response from the API.\n","type":"object","properties":{"httpStatus":{"type":"integer","description":"The HTTP status code of the operation."},"messages":{"type":"array","description":"A list of error messages.\n","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Application internal error code\n"},"message":{"type":"string","description":"A human readable explanation specific to this occurrence of the\nproblem.\n"}}}}}}}}}
```

## The Metadata object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}}}}}
```

## The Pagination object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"Pagination":{"required":["offset","limit","_links"],"description":"Pagination information. The offset and limit parameters are used to\nnavigate the list of elements. The _links object contains URLs to\nnavigate the different pages.\n","type":"object","properties":{"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true},"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true},"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The Offset object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true}}}}
```

## The Limit object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true}}}}
```

## The Links object

```json
{"openapi":"3.0.3","info":{"title":"IONOS Logging Service REST API","version":"0.0.1"},"components":{"schemas":{"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ionos.com/cloud/api-reference/observability/logging-service/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.