> 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/tracing-service/models.md).

# Models

## The PipelineReadList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS CLOUD Tracing","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/MetadataWithEndpoint"},"properties":{"$ref":"#/components/schemas/Pipeline"}}},"MetadataWithEndpoint":{"allOf":[{"$ref":"#/components/schemas/MetadataWithStatus"},{"type":"object","required":["grafanaEndpoint","otlpEndpoint"],"properties":{"grafanaEndpoint":{"type":"string","description":"The endpoint of the Grafana instance.\n","readOnly":true},"otlpEndpoint":{"type":"string","description":"The OTLP ingestion endpoint of the tracing pipeline. The scheme matches the pipeline's `protocol`: `https://` for OTLP HTTP (exporters append `/v1/traces`) and `grpcs://` for OTLP gRPC.\n","readOnly":true},"key":{"type":"string","description":"The authentication key for the pipeline. The API returns this key only in the create response, in the `201` response when ensure creates a new pipeline, and in the key rotation operation (`POST /pipelines/{pipelineId}/key`). Other responses omit it.\n","readOnly":true}}}]},"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 provisioned and is not yet available.\n- AVAILABLE: Resource exists and is ready to accept requests.\n- UPDATING: Resource is being updated and may be temporarily unavailable.\n- DESTROYING: Delete command was issued. Resource is being permanently removed.\n- FAILED: The provisioning failed due to an internal error. Inspect `statusMessage` for details.\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":{"type":"object","description":"Configure the tracing pipeline that defines the OTLP ingestion protocol and endpoint for tenant-isolated trace collection.\n","required":["name","protocol"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be from 1 to 36 characters long and may contain alphanumerics, spaces, underscores, and dashes only.\n","minLength":1,"maxLength":36},"protocol":{"type":"string","description":"The OTLP protocol exposed by this pipeline. Each pipeline exposes one protocol. Changing this value reprovisions the ingestion route behind the same DNS name and may temporarily interrupt ingestion. OTLP HTTP exporters use `/v1/traces`. OTLP gRPC exporters use port 443 without a URL path.\n"}}},"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 CLOUD Tracing","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/MetadataWithEndpoint"},"properties":{"$ref":"#/components/schemas/Pipeline"}}},"MetadataWithEndpoint":{"allOf":[{"$ref":"#/components/schemas/MetadataWithStatus"},{"type":"object","required":["grafanaEndpoint","otlpEndpoint"],"properties":{"grafanaEndpoint":{"type":"string","description":"The endpoint of the Grafana instance.\n","readOnly":true},"otlpEndpoint":{"type":"string","description":"The OTLP ingestion endpoint of the tracing pipeline. The scheme matches the pipeline's `protocol`: `https://` for OTLP HTTP (exporters append `/v1/traces`) and `grpcs://` for OTLP gRPC.\n","readOnly":true},"key":{"type":"string","description":"The authentication key for the pipeline. The API returns this key only in the create response, in the `201` response when ensure creates a new pipeline, and in the key rotation operation (`POST /pipelines/{pipelineId}/key`). Other responses omit it.\n","readOnly":true}}}]},"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 provisioned and is not yet available.\n- AVAILABLE: Resource exists and is ready to accept requests.\n- UPDATING: Resource is being updated and may be temporarily unavailable.\n- DESTROYING: Delete command was issued. Resource is being permanently removed.\n- FAILED: The provisioning failed due to an internal error. Inspect `statusMessage` for details.\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":{"type":"object","description":"Configure the tracing pipeline that defines the OTLP ingestion protocol and endpoint for tenant-isolated trace collection.\n","required":["name","protocol"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be from 1 to 36 characters long and may contain alphanumerics, spaces, underscores, and dashes only.\n","minLength":1,"maxLength":36},"protocol":{"type":"string","description":"The OTLP protocol exposed by this pipeline. Each pipeline exposes one protocol. Changing this value reprovisions the ingestion route behind the same DNS name and may temporarily interrupt ingestion. OTLP HTTP exporters use `/v1/traces`. OTLP gRPC exporters use port 443 without a URL path.\n"}}}}}}
```

## The PipelineEnsure object

```json
{"openapi":"3.0.3","info":{"title":"IONOS CLOUD Tracing","version":"0.0.1"},"components":{"schemas":{"PipelineEnsure":{"type":"object","required":["id","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Pipeline.","format":"uuid"},"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/Pipeline"}}},"Pipeline":{"type":"object","description":"Configure the tracing pipeline that defines the OTLP ingestion protocol and endpoint for tenant-isolated trace collection.\n","required":["name","protocol"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be from 1 to 36 characters long and may contain alphanumerics, spaces, underscores, and dashes only.\n","minLength":1,"maxLength":36},"protocol":{"type":"string","description":"The OTLP protocol exposed by this pipeline. Each pipeline exposes one protocol. Changing this value reprovisions the ingestion route behind the same DNS name and may temporarily interrupt ingestion. OTLP HTTP exporters use `/v1/traces`. OTLP gRPC exporters use port 443 without a URL path.\n"}}}}}}
```

## The PipelineCreate object

```json
{"openapi":"3.0.3","info":{"title":"IONOS CLOUD Tracing","version":"0.0.1"},"components":{"schemas":{"PipelineCreate":{"type":"object","required":["properties"],"properties":{"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/Pipeline"}}},"Pipeline":{"type":"object","description":"Configure the tracing pipeline that defines the OTLP ingestion protocol and endpoint for tenant-isolated trace collection.\n","required":["name","protocol"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be from 1 to 36 characters long and may contain alphanumerics, spaces, underscores, and dashes only.\n","minLength":1,"maxLength":36},"protocol":{"type":"string","description":"The OTLP protocol exposed by this pipeline. Each pipeline exposes one protocol. Changing this value reprovisions the ingestion route behind the same DNS name and may temporarily interrupt ingestion. OTLP HTTP exporters use `/v1/traces`. OTLP gRPC exporters use port 443 without a URL path.\n"}}}}}}
```

## The Pipeline object

```json
{"openapi":"3.0.3","info":{"title":"IONOS CLOUD Tracing","version":"0.0.1"},"components":{"schemas":{"Pipeline":{"type":"object","description":"Configure the tracing pipeline that defines the OTLP ingestion protocol and endpoint for tenant-isolated trace collection.\n","required":["name","protocol"],"properties":{"name":{"type":"string","description":"The name of the pipeline. Must be from 1 to 36 characters long and may contain alphanumerics, spaces, underscores, and dashes only.\n","minLength":1,"maxLength":36},"protocol":{"type":"string","description":"The OTLP protocol exposed by this pipeline. Each pipeline exposes one protocol. Changing this value reprovisions the ingestion route behind the same DNS name and may temporarily interrupt ingestion. OTLP HTTP exporters use `/v1/traces`. OTLP gRPC exporters use port 443 without a URL path.\n"}}}}}}
```

## The KeyRead object

```json
{"openapi":"3.0.3","info":{"title":"IONOS CLOUD Tracing","version":"0.0.1"},"components":{"schemas":{"KeyRead":{"type":"object","description":"Retrieve the newly generated pipeline key. The key rotation operation returns this value once. You cannot retrieve it again later.\n","required":["key"],"properties":{"key":{"type":"string","description":"The newly generated authentication key for the pipeline. The API returns this value only in this response.\n"}}}}}}
```

## The MetadataWithStatus object

```json
{"openapi":"3.0.3","info":{"title":"IONOS CLOUD Tracing","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 provisioned and is not yet available.\n- AVAILABLE: Resource exists and is ready to accept requests.\n- UPDATING: Resource is being updated and may be temporarily unavailable.\n- DESTROYING: Delete command was issued. Resource is being permanently removed.\n- FAILED: The provisioning failed due to an internal error. Inspect `statusMessage` for details.\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 MetadataWithEndpoint object

```json
{"openapi":"3.0.3","info":{"title":"IONOS CLOUD Tracing","version":"0.0.1"},"components":{"schemas":{"MetadataWithEndpoint":{"allOf":[{"$ref":"#/components/schemas/MetadataWithStatus"},{"type":"object","required":["grafanaEndpoint","otlpEndpoint"],"properties":{"grafanaEndpoint":{"type":"string","description":"The endpoint of the Grafana instance.\n","readOnly":true},"otlpEndpoint":{"type":"string","description":"The OTLP ingestion endpoint of the tracing pipeline. The scheme matches the pipeline's `protocol`: `https://` for OTLP HTTP (exporters append `/v1/traces`) and `grpcs://` for OTLP gRPC.\n","readOnly":true},"key":{"type":"string","description":"The authentication key for the pipeline. The API returns this key only in the create response, in the `201` response when ensure creates a new pipeline, and in the key rotation operation (`POST /pipelines/{pipelineId}/key`). Other responses omit it.\n","readOnly":true}}}]},"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 provisioned and is not yet available.\n- AVAILABLE: Resource exists and is ready to accept requests.\n- UPDATING: Resource is being updated and may be temporarily unavailable.\n- DESTROYING: Delete command was issued. Resource is being permanently removed.\n- FAILED: The provisioning failed due to an internal error. Inspect `statusMessage` for details.\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 Error object

```json
{"openapi":"3.0.3","info":{"title":"IONOS CLOUD Tracing","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 CLOUD Tracing","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 CLOUD Tracing","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 CLOUD Tracing","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 CLOUD Tracing","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 CLOUD Tracing","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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
