Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
d428c57
Updating Spect Insert tool to support client code translations
Jun 17, 2025
46b0106
Continued working on the Spect Insert feature for automatic conversio…
Jul 22, 2025
b545d6a
Merge branch 'main' into Spec-Insert->HTTP-to-ProLang_Start
ReveristRealm Jul 25, 2025
5f75fb5
Continued working on the Spect Insert feature for automatic conversio…
Jul 29, 2025
2ac865f
Merge remote-tracking branch 'origin/Spec-Insert->HTTP-to-ProLang_Sta…
Jul 29, 2025
32c1278
Merge branch 'main' into Spec-Insert->HTTP-to-ProLang_Start
ReveristRealm Jul 29, 2025
cd93360
Updating Example Request with spec_insert tags
Jul 31, 2025
d83404b
Continued working on the Spec-Insert tool.
Aug 7, 2025
f26c32d
Continued working on the Spec-Insert tool.
Aug 8, 2025
9f43033
Finished Python Client Code Conversion from HTTP w/ some minor tweaks.
Aug 8, 2025
9df6657
Merge branch 'main' into Spec-Insert->HTTP-to-ProLang_Start
ReveristRealm Aug 8, 2025
dd4ebbe
Merge remote-tracking branch 'origin/Spec-Insert->HTTP-to-ProLang_Sta…
Aug 8, 2025
1c99540
Finished Python Client Code Conversion from HTTP w/ some minor tweaks.
Aug 13, 2025
d5d987f
Merge remote-tracking branch 'origin/Spec-Insert->HTTP-to-ProLang_Sta…
Aug 14, 2025
758e9b6
Finished Spec-Insert feature allowing for multi-language support.
Aug 15, 2025
2a9bb71
Merge branch 'main' into tags
ReveristRealm Aug 15, 2025
44c8528
Apply suggestions from code review
kolchfa-aws Sep 2, 2025
7e37d7b
Apply suggestions from code review
kolchfa-aws Sep 2, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 64 additions & 13 deletions _api-reference/cat/cat-allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ include_deprecated: false
-->
## Query parameters

The following table lists the available query parameters. All query parameters are optional.
The following table lists the available query parameters.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ReveristRealm Why did the "All query parameters are optional." get deleted? It is important information.


| Parameter | Data type | Description | Default |
| :--- | :--- | :--- | :--- |
Expand All @@ -53,24 +53,75 @@ The following table lists the available query parameters. All query parameters a

## Example requests

```json
GET _cat/allocation?v
```
{% include copy-curl.html %}
<!-- spec_insert_start
component: example_code
rest: GET /_cat/allocation?v
-->
{% capture step1_rest %}
GET /_cat/allocation?v
{% endcapture %}

{% capture step1_python %}


response = client.cat.allocation(
params = { "v": "false" }
)

{% endcapture %}

{% include code-block.html
rest=step1_rest
python=step1_python %}
<!-- spec_insert_end -->

To limit the information to a specific node, add the node name after your query:

```json
GET _cat/allocation/<node_name>
```
{% include copy-curl.html %}
<!-- spec_insert_start
component: example_code
rest: GET /_cat/allocation/<node_name>
-->
{% capture step1_rest %}
GET /_cat/allocation/<node_name>
{% endcapture %}

{% capture step1_python %}


response = client.cat.allocation(
node_id = "<node_name>"
)

{% endcapture %}

{% include code-block.html
rest=step1_rest
python=step1_python %}
<!-- spec_insert_end -->

If you want to get information for more than one node, separate the node names with commas:

```json
GET _cat/allocation/node_name_1,node_name_2,node_name_3
```
{% include copy-curl.html %}
<!-- spec_insert_start
component: example_code
rest: GET /_cat/allocation/node_name_1,node_name_2,node_name_3
-->
{% capture step1_rest %}
GET /_cat/allocation/node_name_1,node_name_2,node_name_3
{% endcapture %}

{% capture step1_python %}


response = client.cat.allocation(
node_id = "node_name_1,node_name_2,node_name_3"
)

{% endcapture %}

{% include code-block.html
rest=step1_rest
python=step1_python %}
<!-- spec_insert_end -->

## Example response

Expand Down