# API के साथ Dedicated Deployments manage करें

सूचनाएँ:

* सभी endpoints होस्ट किए गए हैं `https://roboflow.cloud`.
* प्रतिक्रिया कोड जांचें:
  * यदि यह `200`, तो प्रतिक्रिया बॉडी को JSON ऑब्जेक्ट के रूप में डिकोड करें।
  * अन्यथा, प्रतिक्रिया बॉडी में एक त्रुटि संदेश स्ट्रिंग के रूप में होता है।

<details>

<summary>POST /add — एक Dedicated Deployment बनाएं</summary>

**Request Body उदाहरण (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
}
```

**Request Body Schema (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`

**Response उदाहरण (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
}
```

**Response Schema (json)**

* deployment\_id (string): एक अनूठा पहचानकर्ता
* deployment\_name (string)
* machine\_type (string)
* creator\_email (string)
* creator\_id (string): उस user id के अनुरूप जो `creator_email`
* subdomain (string): हमेशा वही नहीं होता जैसा कि `deployment_name`, यदि subdomain पहले से लिया गया है तो हम कुछ उपसर्ग जोड़ देंगे
* domain (string)
* duration (float)
* inference\_version (string)
* min\_replicas (integer)
* max\_replicas (integer)
* num\_replicas (integer): वर्तमान उपलब्ध replicas
* status (string)
* workspace\_id (string)
* workspace\_url (string)

</details>

<details>

<summary>GET /list — आपके Workspace में Dedicated Deployments की सूची</summary>

**Query Parameters**

* api\_key (string): अनिवार्य
* show\_expired (string): वैकल्पिक, डिफ़ॉल्ट है `false`
* show\_deleted (string): वैकल्पिक, डिफ़ॉल्ट है `false`

**Response उदाहरण (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
}
]
```

**Response Schema (json)**

Dedicated Deployment प्रविष्टियों की एक सूची, जबकि प्रत्येक प्रविष्टि का schema उसी के समान है जैसा कि वर्णित है [/add](#post-add-create-a-dedicated-deployment) endpoint.

</details>

<details>

<summary>GET /get — एक Dedicated Deployment का विवरण प्राप्त करें</summary>

**Query Parameters**

* api\_key (string): अनिवार्य
* deployment\_name (string): अनिवार्य

**Response उदाहरण (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
}
```

**Response Schema (json)**

उसी schema के साथ जैसी प्रतिक्रिया [/add](#post-add-create-a-dedicated-deployment) endpoint.

</details>

<details>

<summary>GET /get_log — एक Dedicated Deployment के लॉग प्राप्त करें</summary>

**Query Parameters**

* 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) फॉर्मेट, डिफ़ॉल्ट वर्तमान समय है

**Response उदाहरण (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"
	}
]
```

**Response Schema (json)**

लॉग प्रविष्टियों की एक सूची, जबकि प्रत्येक प्रविष्टि में निम्नलिखित गुण होते हैं:

* insert\_id (string): प्रत्येक लॉग प्रविष्टि के लिए अनूठा पहचानकर्ता
* payload (string): लॉग सामग्री
* severity (string)
* timestamp (string)

</details>

<details>

<summary>POST /pause — एक Dedicated Deployment को Pause करें</summary>

**Request Body उदाहरण (json)**

```
{
	"api_key": API_KEY,
	"deployment_name": "dev-testing"
}
```

**Request Body Schema (json)**

* api\_key (string): अनिवार्य
* deployment\_name (string): आवश्यक

**Response उदाहरण (json)**

```
{
	"message": "OK"
}
```

**Response Schema**

* message (string)

</details>

<details>

<summary>POST /resume — एक Dedicated Deployment को Resume करें</summary>

**Request Body उदाहरण (json)**

```
{
	"api_key": API_KEY,
	"deployment_name": "dev-testing"
}
```

**Request Body Schema (json)**

* api\_key (string): अनिवार्य
* deployment\_name (string): आवश्यक

**Response उदाहरण (json)**

```
{
	"message": "OK"
}
```

**Response Schema**

* message (string)

</details>

<details>

<summary>POST /delete — एक Dedicated Deployment को Delete करें</summary>

**Request Body उदाहरण (json)**

```
{
	"api_key": API_KEY,
	"deployment_name": "dev-testing"
}
```

**Request Body Schema (json)**

* api\_key (string): अनिवार्य
* deployment\_name (string): आवश्यक

**Response उदाहरण (json)**

```
{
	"message": "OK"
}
```

**Response Schema**

* message (string)

</details>