---
title: URI parts processor
description: Parses a Uniform Resource Identifier (URI) string and extracts its components as an object. This URI object includes properties for the URI’s domain,...
url: https://docs-v3-preview.elastic.dev/elastic/elasticsearch/tree/main/reference/ingest-processor/uri-parts-processor
products:
  - Elasticsearch
---

# URI parts processor
Parses a Uniform Resource Identifier (URI) string and extracts its components as an object. This URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password.
The processor uses [java.net.URI](https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/net/URI.html) to parse the URI string, which as of Java 24 supports [RFC 2396](https://datatracker.ietf.org/doc/html/rfc2396), amended by [RFC 2732](https://datatracker.ietf.org/doc/html/rfc2732). The most recent URI syntax RFC is [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986), meaning this processor might not parse URIs that depend on [features specific to RFC 3986](https://www.rfc-editor.org/info/rfc3986/#appendix-D) as expected.


| Name                   | Required | Default | Description                                                                                                                                                                                                                    |
|------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `field`                | yes      | -       | Field containing the URI string.                                                                                                                                                                                               |
| `target_field`         | no       | `url`   | Output field for the URI object.                                                                                                                                                                                               |
| `keep_original`        | no       | true    | If `true`, the processor copies the unparsed URI to `<target_field>.original`.                                                                                                                                                 |
| `remove_if_successful` | no       | false   | If `true`, the processor removes the `field` after parsing the URI string. If parsing fails, the processor does notremove the `field`.                                                                                         |
| `ignore_missing`       | no       | `false` | If `true` and `field` does not exist, the processor quietly exits without modifying the document                                                                                                                               |
| `description`          | no       | -       | Description of the processor. Useful for describing the purpose of the processor or its configuration.                                                                                                                         |
| `if`                   | no       | -       | Conditionally execute the processor. See [Conditionally run a processor](https://docs-v3-preview.elastic.dev/elastic/docs-content/tree/main/manage-data/ingest/transform-enrich/ingest-pipelines#conditionally-run-processor). |
| `ignore_failure`       | no       | `false` | Ignore failures for the processor. See [Handling pipeline failures](https://docs-v3-preview.elastic.dev/elastic/docs-content/tree/main/manage-data/ingest/transform-enrich/ingest-pipelines#handling-pipeline-failures).       |
| `on_failure`           | no       | -       | Handle failures for the processor. See [Handling pipeline failures](https://docs-v3-preview.elastic.dev/elastic/docs-content/tree/main/manage-data/ingest/transform-enrich/ingest-pipelines#handling-pipeline-failures).       |
| `tag`                  | no       | -       | Identifier for the processor. Useful for debugging and metrics.                                                                                                                                                                |

Here is an example definition of the URI parts processor:
```js
{
  "description" : "...",
  "processors" : [
    {
      "uri_parts": {
        "field": "input_field",
        "target_field": "url",
        "keep_original": true,
        "remove_if_successful": false
      }
    }
  ]
}
```

When the above processor executes on the following document:
```js
{
  "_source": {
    "input_field": "http://myusername:mypassword@<example-url>:80/foo.gif?key1=val1&key2=val2#fragment"
  }
}
```

It produces this result:
```js
"_source" : {
  "input_field" : "http://myusername:mypassword@<example-url>:80/foo.gif?key1=val1&key2=val2#fragment",
  "url" : {
    "path" : "/foo.gif",
    "fragment" : "fragment",
    "extension" : "gif",
    "password" : "mypassword",
    "original" : "http://myusername:mypassword@<example-url>:80/foo.gif?key1=val1&key2=val2#fragment",
    "scheme" : "http",
    "port" : 80,
    "user_info" : "myusername:mypassword",
    "domain" : "www.example.com",
    "query" : "key1=val1&key2=val2",
    "username" : "myusername"
  }
}
```