Instances API Reference
This section covers all endpoints related to instances.
Get Launch Config
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| chute_id | string | Yes | |
| job_id | string | null | No | |
| X-Chutes-Hotkey | string | null | No | |
| X-Chutes-Signature | string | null | No | |
| X-Chutes-Nonce | string | null | No | |
| Authorization | string | null | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Authentication
This endpoint requires authentication.
Claim Launch Config
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| config_id | string | Yes | |
| Authorization | string | No | |
Request Body
| Field | Type | Required | Description |
|---|
| gpus | object[] | Yes | |
| host | string | Yes | |
| port_mappings | PortMap[] | Yes | |
| env | string | Yes | |
| code | string | Yes | |
| fsv | string | null | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Verify Launch Config Instance
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| config_id | string | Yes | |
| Authorization | string | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Activate Launch Config Instance
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| config_id | string | Yes | |
| Authorization | string | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Create Instance
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| chute_id | string | Yes | |
| X-Chutes-Hotkey | string | null | No | |
| X-Chutes-Signature | string | null | No | |
| X-Chutes-Nonce | string | null | No | |
| Authorization | string | null | No | |
Request Body
| Field | Type | Required | Description |
|---|
| node_ids | string[] | Yes | |
| host | string | Yes | |
| port | integer | Yes | |
Responses
| Status Code | Description |
|---|
| 202 | Successful Response |
| 422 | Validation Error |
Authentication
This endpoint requires authentication.
Get Token
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| salt | string | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Activate Instance
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| chute_id | string | Yes | |
| instance_id | string | Yes | |
| X-Chutes-Hotkey | string | null | No | |
| X-Chutes-Signature | string | null | No | |
| X-Chutes-Nonce | string | null | No | |
| Authorization | string | null | No | |
Request Body
| Field | Type | Required | Description |
|---|
| active | boolean | Yes | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Authentication
This endpoint requires authentication.
Delete Instance
Endpoint:
Parameters
| Parameter | Type | Required | Description |
|---|
| chute_id | string | Yes | |
| instance_id | string | Yes | |
| X-Chutes-Hotkey | string | null | No | |
| X-Chutes-Signature | string | null | No | |
| X-Chutes-Nonce | string | null | No | |
| Authorization | string | null | No | |
Responses
| Status Code | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Authentication
This endpoint requires authentication.