Skip to content

Fix curl command name, syntax, and url #2377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Grid status provides the current state of the Grid. It consists of details about
For every Node, the status includes information regarding Node availability, sessions, and slots.

```shell
cURL GET 'http://localhost:4444/status'
curl --request GET 'http://localhost:4444/status'
```

### Delete session
Expand All @@ -25,7 +25,7 @@ Deleting the session terminates the WebDriver session, quits the driver and remo
Any request using the removed session-id or reusing the driver instance will throw an error.

```shell
cURL --request DELETE 'http://localhost:4444/session/<session-id>'
curl --request DELETE 'http://localhost:4444/session/<session-id>'
```

### Which URL should I use?
Expand All @@ -42,7 +42,7 @@ Default URL for all the above modes is http://localhost:4444.

### Remove Node

To remove the Node from the Grid, use the cURL command enlisted below.
To remove the Node from the Grid, use the curl command enlisted below.
It does not stop any ongoing session running on that Node.
The Node continues running as it is unless explicitly killed.
The Distributor is no longer aware of the Node and hence any matching new session request
Expand All @@ -52,15 +52,15 @@ In the Standalone mode, the Distributor URL is the Standalone server address.

In the Hub-Node mode, the Distributor URL is the Hub server address.
```shell
cURL --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret> '
curl --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret> '
```
In the fully distributed mode, the URL is the Router server address.
```shell
cURL --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret>'
```
If no registration secret has been configured while setting up the Grid, then use
```shell
cURL --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET;'
curl --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET;'
```

### Drain Node
Expand All @@ -73,15 +73,15 @@ In the Standalone mode, the Distributor URL is the Standalone server address.

In the Hub-Node mode, the Distributor URL is the Hub server address.
```shell
cURL --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret> '
curl --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret> '
```
In the fully distributed mode, the URL is the Router server address.
```shell
cURL --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret>'
```
If no registration secret has been configured while setting up the Grid, then use
```shell
cURL --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET;'
curl --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET;'
```

## Node
Expand All @@ -94,37 +94,37 @@ In case of multiple Nodes, use [Grid status](#grid-status) to get all Node detai
### Status

The Node status is essentially a health-check for the Node.
Distributor pings the node status are regular intervals and updates the Grid Model accordingly.
Distributor pings the node status at regular intervals and updates the Grid Model accordingly.
The status includes information regarding availability, sessions, and slots.

```shell
cURL --request GET 'http://localhost:5555/status'
curl --request GET 'http://localhost:5555/status'
```

### Drain

Distributor passes the [drain](#drain-node) command to the appropriate node identified by the node-id.
To drain the Node directly, use the cuRL command enlisted below.
To drain the Node directly, use the curl command enlisted below.
Both endpoints are valid and produce the same result. Drain finishes the ongoing sessions before stopping the Node.

```shell
cURL --request POST 'http://localhost:5555/se/grid/node/drain' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request POST 'http://localhost:5555/se/grid/node/drain' --header 'X-REGISTRATION-SECRET: <secret>'
```
If no registration secret has been configured while setting up the Grid, then use
```shell
cURL --request POST 'http://<node-URL>/se/grid/node/drain' --header 'X-REGISTRATION-SECRET;'
curl --request POST 'http://<node-URL>/se/grid/node/drain' --header 'X-REGISTRATION-SECRET;'
```

### Check session owner

To check if a session belongs to a Node, use the cURL command enlisted below.
To check if a session belongs to a Node, use the curl command enlisted below.

```shell
cURL --request GET 'http://localhost:5555/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request GET 'http://localhost:5555/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
```
If no registration secret has been configured while setting up the Grid, then use
```shell
cURL --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET;'
curl --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET;'
```

It will return true if the session belongs to the Node else it will return false.
Expand All @@ -135,19 +135,19 @@ Deleting the session terminates the WebDriver session, quits the driver and remo
Any request using the removed session-id or reusing the driver instance will throw an error.

```shell
cURL --request DELETE 'http://localhost:5555/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request DELETE 'http://localhost:5555/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
```
If no registration secret has been configured while setting up the Grid, then use
```shell
cURL --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET;'
curl --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET;'
```

## New Session Queue

### Clear New Session Queue

New Session Request Queue holds the new session requests.
To clear the queue, use the cURL command enlisted below.
To clear the queue, use the curl command enlisted below.
Clearing the queue rejects all the requests in the queue. For each such request, the server returns an error response to the respective client.
The result of the clear command is the total number of deleted requests.

Expand All @@ -156,33 +156,33 @@ In the Standalone mode, the Queue URL is the Standalone server address.
In the Hub-Node mode, the Queue URL is the Hub server address.

```shell
cURL --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
```

In the fully distributed mode, the Queue URL is Router server address.
```shell
cURL --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
```

If no registration secret has been configured while setting up the Grid, then use
```shell
cURL --request DELETE 'http://<Router-URL>/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET;'
curl --request DELETE 'http://<Router-URL>/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET;'
```

### Get New Session Queue Requests

New Session Request Queue holds the new session requests.
To get the current requests in the queue, use the cURL command enlisted below.
To get the current requests in the queue, use the curl command enlisted below.
The response returns the total number of requests in the queue and the request payloads.

In the Standalone mode, the Queue URL is the Standalone server address.

In the Hub-Node mode, the Queue URL is the Hub server address.

```shell
cURL --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
curl --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
```

In the fully distributed mode, the Queue URL is Router server address.
```shell
cURL --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
curl --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Grid ステータスは Grid の現在の状態を提供します。 登録さ
各ノードのステータスには、ノードの稼働状況、セッション、およびスロットに関する情報が含まれます。

```shell
cURL GET 'http://localhost:4444/status'
curl --request GET 'http://localhost:4444/status'
```

### セッションの削除
Expand All @@ -25,7 +25,7 @@ cURL GET 'http://localhost:4444/status'
削除されたセッション ID を使用するリクエストや、ドライバのインスタンスを再利用しようとすると、エラーとなります。

```shell
cURL --request DELETE 'http://localhost:4444/session/<session-id>'
curl --request DELETE 'http://localhost:4444/session/<session-id>'
```

### Which URL should I use?
Expand All @@ -42,7 +42,7 @@ cURL --request DELETE 'http://localhost:4444/session/<session-id>'

### ノード削除

ノードを Grid から削除するには、以下の cURL コマンドを使用します。
ノードを Grid から削除するには、以下の curl コマンドを使用します。
このコマンドは、そのノード上で実行中のセッションを停止させるものではありません。
ノードは明示的に強制終了されない限り、そのまま動作し続けます。
ディストリビューターはそのノードを認識しなくなるため、マッチする新しいセッションのリクエストは はその Node に転送されません。
Expand All @@ -52,19 +52,19 @@ cURL --request DELETE 'http://localhost:4444/session/<session-id>'
ハブ&ノードモードでは、ディストリビューターの URL は ハブのアドレスになります。

```shell
cURL --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret> '
curl --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret> '
```

完全分散モードでは、ディストリビューター URL は ディストリビューターのアドレスになります。

```shell
cURL --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request DELETE 'http://localhost:4444/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET: <secret>'
```

Grid の設定時に登録用の secret を設定していない場合は次のようにします:

```shell
cURL --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET;'
curl --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' --header 'X-REGISTRATION-SECRET;'
```

### ノードのドレイン
Expand All @@ -78,19 +78,19 @@ cURL --request DELETE 'http://<Router-URL>/se/grid/distributor/node/<node-id>' -
ハブ&ノードモードでは、ディストリビューターの URL は ハブのアドレスになります。

```shell
cURL --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret> '
curl --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret> '
```

完全分散モードでは、ディストリビューター URL は ディストリビューターのアドレスになります。

```shell
cURL --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request POST 'http://localhost:4444/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET: <secret>'
```

Grid の設定時に登録用の secret を設定していない場合は次のようにします:

```shell
cURL --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET;'
curl --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drain' --header 'X-REGISTRATION-SECRET;'
```

## ノード
Expand All @@ -106,38 +106,38 @@ cURL --request POST 'http://<Router-URL>/se/grid/distributor/node/<node-id>/drai
ステータスには稼働状況、セッション、およびスロットに関する情報が含まれます。

```shell
cURL --request GET 'http://localhost:5555/status'
curl --request GET 'http://localhost:5555/status'
```

### ドレイン

ディストリビューターは [ドレイン](#ノードのドレイン)コマンドを適切なノードに渡します。
ノードを直接ドレインするには以下の cURL コマンドを使います。
ノードを直接ドレインするには以下の curl コマンドを使います。
どちらのエンドポイントも有効であり、同じ結果になります。
ドレインは、ノードを停止する前に進行中のセッションを終了させます。

```shell
cURL --request POST 'http://localhost:5555/se/grid/node/drain' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request POST 'http://localhost:5555/se/grid/node/drain' --header 'X-REGISTRATION-SECRET: <secret>'
```

Grid の設定時に登録用の secret を設定していない場合は次のようにします:

```shell
cURL --request POST 'http://<node-URL>/se/grid/node/drain' --header 'X-REGISTRATION-SECRET;'
curl --request POST 'http://<node-URL>/se/grid/node/drain' --header 'X-REGISTRATION-SECRET;'
```

### セッションオーナーのチェック

あるセッションがノードに属しているかどうかをチェックするには、以下の cURL コマンドを使います。
あるセッションがノードに属しているかどうかをチェックするには、以下の curl コマンドを使います。

```shell
cURL --request GET 'http://localhost:5555/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request GET 'http://localhost:5555/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
```

Grid の設定時に登録用の secret を設定していない場合は次のようにします:

```shell
cURL --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET;'
curl --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header 'X-REGISTRATION-SECRET;'
```

もしセッションがノードに属していたら true を返し、そうでなければ false が返ります。
Expand All @@ -148,21 +148,21 @@ cURL --request GET 'http://<node-URL>/se/grid/node/owner/<session-id>' --header
削除されたセッション ID を使用するリクエストや、ドライバのインスタンスを再利用しようとすると、エラーとなります。

```shell
cURL --request DELETE 'http://localhost:5555/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request DELETE 'http://localhost:5555/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET: <secret>'
```

Grid の設定時に登録用の secret を設定していない場合は次のようにします:

```shell
cURL --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET;'
curl --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --header 'X-REGISTRATION-SECRET;'
```

## 新規セッションキュー

### 新規セッションキューのクリア

新規セッションキューには、新規セッションリクエストが格納されます。
キューをクリアするには、以下に挙げる cURL コマンドを使用します。
キューをクリアするには、以下に挙げる curl コマンドを使用します。
キューを消去すると、キューにあるすべてのリクエストを拒否します。
サーバーは各リクエストのそれぞれのクライアントにエラーレスポンスを返します。
クリアコマンドの結果は、削除されたリクエストの数です。
Expand All @@ -172,37 +172,37 @@ cURL --request DELETE 'http://<node-URL>/se/grid/node/session/<session-id>' --he
ハブ&ノードモードでは、キューの URL は ハブのアドレスになります。

```shell
cURL --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
```

完全分散モードでは、キューの URL は 新規セッションキューのアドレスになります。

```shell
cURL --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
curl --request DELETE 'http://localhost:4444/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET: <secret>'
```

Grid の設定時に登録用の secret を設定していない場合は次のようにします:

```shell
cURL --request DELETE 'http://<Router-URL>/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET;'
curl --request DELETE 'http://<Router-URL>/se/grid/newsessionqueue/queue' --header 'X-REGISTRATION-SECRET;'
```

### 新規セッションリクエストの取得

新規セッションキューには、新規セッションリクエストが格納されます。
キューにある現在のリクエストを取得するには、以下に挙げる cURL コマンドを使用します。
キューにある現在のリクエストを取得するには、以下に挙げる curl コマンドを使用します。
レスポンスはキュー内のリクエストの数とリクエストのペイロードを返します。

スタンドアロンモードでは、キューの URL はスタンドアロンサーバーのアドレスとなります。

ハブ&ノードモードでは、キューの URL は ハブのアドレスになります。

```shell
cURL --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
curl --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
```

完全分散モードでは、キューの URL は 新規セッションキューのアドレスになります。

```shell
cURL --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
curl --request GET 'http://localhost:4444/se/grid/newsessionqueue/queue'
```
Loading
Loading