GET
/
rentals
/
{rentalId}
Get rental
curl --request GET \
  --url https://api.gputrader.io/v1/rentals/{rentalId} \
  --header 'X-API-Key: <api-key>'
{
  "rentalId": "<string>",
  "listing": {},
  "userId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "name": "My Instance",
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isSeed": true
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
rentalId
string
required

Rental ID

Query Parameters

​
excludeStacks
boolean
default:false

Whether to exclude stack information from the response

Response

Successfully retrieved rental information

​
rentalId
string

Unique identifier for the rental

​
listing
object

Environment listing details

​
userId
string

ID of the user who created the rental

​
startDate
string<date-time>

Start date and time of the rental

​
endDate
string<date-time>

End date and time of the rental

​
name
string
default:My Instance

Name of the rental instance

​
status
enum<string>

Current status of the rental

Available options:
ACTIVE,
COMPLETE
​
createdAt
string<date-time>

Timestamp when the rental was created

​
updatedAt
string<date-time>

Timestamp when the rental was last updated

​
isSeed
boolean

Indicates if this is a seed rental