# API で Dedicated Deployments を管理
注意事項:
* すべてのエンドポイントは次の場所でホストされています `https://roboflow.cloud`.
* レスポンスコードを確認してください:
* もし `200`であれば、レスポンス本文をJSONオブジェクトとしてデコードします。
* それ以外の場合、レスポンス本文にはエラーメッセージが文字列として含まれます。
POST /add — dedicated deployment を作成
**リクエスト本文の例 (json)**
```
{
"api_key": API_KEY,
"deployment_name": "dev-testing",
"machine_type": "dev-gpu",
"creator_email": YOUR_EMAIL_ADDRESS,
"duration": 3.0,
"inference_version": "latest",
"min_replicas": 1,
"max_replicas": 1
}
```
**リクエスト本文のスキーマ (json)**
* api\_key (string): 必須
* deployment\_name (string): 必須
* machine\_type (string): 必須
* creator\_email (string): 必須
* duration (float): 任意、単位は時間。デフォルトは `3`
* inference\_version (string): 任意、デフォルトは `latest`
* min\_replicas (integer): 任意、デフォルトは `1`
* max\_replicas (integer): 任意、デフォルトは `1`
**レスポンス例 (json)**
```
{
"deployment_id": "IwzJ5YLQ0iDhwzqoh3Ae",
"deployment_name": "dev-testing",
"machine_type": "dev-gpu",
"creator_email": YOUR_EMAIL_ADDRESS,
"creator_id": YOUR_USER_ID,
"subdomain": "dev-testing",
"domain": "dev-testing.roboflow.cloud",
"duration": 3.0,
"inference_version": "0.45.0",
"max_replicas": 1,
"min_replicas": 1,
"num_replicas": 0,
"status": "pending",
"workspace_id": YOUR_WORKSPACE_ID,
"workspace_url": YOUR_WORKSPACE_URL
}
```
**レスポンスのスキーマ (json)**
* deployment\_id (string): 一意の識別子
* deployment\_name (string)
* machine\_type (string)
* creator\_email (string)
* creator\_id (string): 対応するユーザーID `creator_email`
* subdomain (string): 常に `deployment_name`と同じとは限りません。subdomain がすでに使用されている場合は、接尾辞を追加します
* domain (string)
* duration (float)
* inference\_version (string)
* min\_replicas (integer)
* max\_replicas (integer)
* num\_replicas (integer): 現在利用可能なレプリカ数
* status (string)
* workspace\_id (string)
* workspace\_url (string)
GET /list — あなたの Workspace 内の dedicated deployment を一覧表示
**クエリパラメータ**
* api\_key (string): 必須
* show\_expired (string): 任意、デフォルトは `false`
* show\_deleted (string): 任意、デフォルトは `false`
**レスポンス例 (json)**
```
[
{
"deployment_id": "IwzJ5YLQ0iDhwzqoh3Ae",
"deployment_name": "dev-testing",
"machine_type": "dev-gpu",
"creator_email": YOUR_EMAIL_ADDRESS,
"creator_id": YOUR_USER_ID,
"subdomain": "dev-testing",
"domain": "dev-testing.roboflow.cloud",
"duration": 3.0,
"inference_version": "0.45.0",
"max_replicas": 1,
"min_replicas": 1,
"num_replicas": 0,
"status": "pending",
"workspace_id": YOUR_WORKSPACE_ID,
"workspace_url": YOUR_WORKSPACE_URL
}
]
```
**レスポンスのスキーマ (json)**
dedicated deployment エントリの一覧。各エントリは、で説明されているものと同じスキーマを持ちます [/add](#post-add-create-a-dedicated-deployment) エンドポイント。
GET /get — dedicated deployment の詳細を取得
**クエリパラメータ**
* api\_key (string): 必須
* deployment\_name (string): 必須
**レスポンス例 (json)**
```
{
"deployment_id": "IwzJ5YLQ0iDhwzqoh3Ae",
"deployment_name": "dev-testing",
"machine_type": "dev-gpu",
"creator_email": YOUR_EMAIL_ADDRESS,
"creator_id": YOUR_USER_ID,
"subdomain": "dev-testing",
"domain": "dev-testing.roboflow.cloud",
"duration": 3.0,
"inference_version": "0.45.0",
"max_replicas": 1,
"min_replicas": 1,
"num_replicas": 0,
"status": "pending",
"workspace_id": YOUR_WORKSPACE_ID,
"workspace_url": YOUR_WORKSPACE_URL
}
```
**レスポンスのスキーマ (json)**
次のレスポンスと同じスキーマ [/add](#post-add-create-a-dedicated-deployment) エンドポイント。
GET /get_log — dedicated deployment のログを取得
**クエリパラメータ**
* api\_key (string): 必須
* deployment\_name (string): 必須
* max\_entries (integer): 任意、デフォルトは 50
* from\_timestamp (string): 任意、 [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) 形式で指定。デフォルトは現在時刻の1時間前
* to\_timestamp (string): 任意、 [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) 形式で指定。デフォルトは現在時刻
**レスポンス例 (json)**
```
[
{
"insert_id": "gpwrgrw55p7b9jdq",
"payload": "INFO: 10.18.0.38:46296 - \"GET /info HTTP/1.1\" 200 OK",
"severity": "INFO",
"timestamp": "2025-01-22T13:23:14.209436+00:00"
},
{
"insert_id": "mbieh16zdjvqp81j",
"payload": "INFO: 10.18.0.38:46294 - \"GET /info HTTP/1.1\" 200 OK",
"severity": "INFO",
"timestamp": "2025-01-22T13:23:14.208738+00:00"
},
{
"insert_id": "0odfnfwh8ts6e4jt",
"payload": "INFO: 10.18.0.38:54650 - \"GET /info HTTP/1.1\" 200 OK",
"severity": "INFO",
"timestamp": "2025-01-22T13:22:14.209054+00:00"
},
{
"insert_id": "s3nabhyhejuke6ub",
"payload": "INFO: 10.18.0.38:54640 - \"GET /info HTTP/1.1\" 200 OK",
"severity": "INFO",
"timestamp": "2025-01-22T13:22:14.208329+00:00"
},
{
"insert_id": "2cz5u3jx4ma22tl8",
"payload": "INFO: 10.18.0.38:40264 - \"GET /info HTTP/1.1\" 200 OK",
"severity": "INFO",
"timestamp": "2025-01-22T13:21:14.209900+00:00"
}
]
```
**レスポンスのスキーマ (json)**
ログエントリの一覧。各エントリには次の属性があります:
* insert\_id (string): 各ログエントリの一意の識別子
* payload (string): ログ内容
* severity (string)
* timestamp (string)
POST /pause — dedicated deployment を一時停止
**リクエスト本文の例 (json)**
```
{
"api_key": API_KEY,
"deployment_name": "dev-testing"
}
```
**リクエスト本文のスキーマ (json)**
* api\_key (string): 必須
* deployment\_name (string): 必須
**レスポンス例 (json)**
```
{
"message": "OK"
}
```
**レスポンスのスキーマ**
* message (string)
POST /resume — dedicated deployment を再開
**リクエスト本文の例 (json)**
```
{
"api_key": API_KEY,
"deployment_name": "dev-testing"
}
```
**リクエスト本文のスキーマ (json)**
* api\_key (string): 必須
* deployment\_name (string): 必須
**レスポンス例 (json)**
```
{
"message": "OK"
}
```
**レスポンスのスキーマ**
* message (string)
POST /delete — dedicated deployment を削除
**リクエスト本文の例 (json)**
```
{
"api_key": API_KEY,
"deployment_name": "dev-testing"
}
```
**リクエスト本文のスキーマ (json)**
* api\_key (string): 必須
* deployment\_name (string): 必須
**レスポンス例 (json)**
```
{
"message": "OK"
}
```
**レスポンスのスキーマ**
* message (string)
---
# Agent Instructions: 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:
```
GET https://docs.roboflow.com/roboflow/roboflow-jp/deploy/dedicated-deployments/manage-dedicated-deployments-with-an-api.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.