iRender APIs
We provide the controls as Restful API. It’s easy and convenient to integrate interaction with iRender from your application. You can easily send API requests to boot the server image, shut it down, etc.
Don’t worry. It won’t cost you any extra money to use these APIs.
CONTENTS
To enable the iRender APIs
To enable the iRender APIs, follow instructions as described below:
1. Go to https://app.gpuhub.net/api » Enable access to iRender APIs.
2. Add Domains & IP address restrictions: We only accept requests of domains or IP addresses in this list.
How to use the iRender APIs: API documentation
Refer to the GpuHub APIs documentation. The reference includes detailed API parameters and provides the Test tool.
1. API Parameters
- apiToken: Tokens provided upon activation of API integration.
- imageId: the id of the image executes a specific action (boot, shut down, get information).
2. API responses
GENERAL
| ERROR CODE | MESSAGE | DESCRIPTION |
| 62001 | API_TOKEN_INVALID | The API token is not available. Update new API token to use. |
| 62001 | API_TOKEN_INFO_FAILED | API token check failed, please try again. |
| 62002 | API_TOKEN_EXPIRED | API token has expired. Update new API token to use. |
| 62003 | REQUEST_SOURCE_BLOCKED | The API is called from an unlicensed source. Add licensed sources to the list. |
| 54001 | GET_USER_INFOMATION_FAILED | User information check failed. |
| 1050101 | GET_IMAGE_INFOMATION_FAILED | Image information check failed. |
SHUTDOWN
| ERROR CODE | MESSAGE | DESCRIPTION |
| 1 | SUCCESS | The request to shut down the server was successful. |
| 2 | CURRENT_STATE_{STATUS} | The image status is {STATUS}, can not continue. Wait for the image to change the status. |
| 62004 | REQUEST_TOO_MANY_TIME | The request has been called too many times. |
BOOT
| ERROR CODE | MESSAGE | DESCRIPTION |
| 1 | SUCCESS | The request to boot the server image was successful. |
| 2 | FIXED_RENTAL_TOO_EARLY | The fixed rental period is not valid. |
| 3 | FIXED_RENTAL_EXPIRED | The fixed rental period expired, so you cannot boot the image. Cancel the request or renew the fixed rental period. |
| 4 | BALANCE_NOT_ENOUGH | Account balance is not enough to boot the image or run it. |
| 5 | TOTAL_RECHARGE_NOT_ENOUGH | The recharge amount is under the minimum. |
| 6 | MACHINE_NOT_AVAILABLE | No machines are available. |
| 7 | MAC_USED | The hardware fixation (fix MAC address) was applied for your server image. However, the hardware is currently being used. Boot the server image later or disable hardware fixation (in case of deactivating all software license keys previously). |
| 8 | MACHINE_SNAPSHOT_PROCCESSING | The image that is being created as a snapshot cannot be booted. |
| 9 | CURRENT_STATE_{STATUS} | The image status is {STATUS}, can not continue. Wait for the image to change the status. |
GET IMAGE LIST / IMAGE INFORMATION
| ERROR CODE | MESSAGE | DESCRIPTION |
| 1 | SUCCESS | The request to get the list of images (or details of a specific image) was successful. |
Octane License at iRender
