Before you start, ensure that you have API Key with
Instances -> Read
permission (or Read and Write
if you want to Delete
instances)Retrieving Existing Pods
To view a list of active instances, use the Get Pods endpoint.limit
of 100 results. To adjust the number of results per page, use query parameters:
total_count
), the specified limit
and offset
and the list of pods under data
(check out Pod schema for details)
Retrieving a Specific Pod
If you know thepodId
, you can retrieve details for that specific pod:
Checking Pod Status
After provisioning an instance, retrieve its status to obtain port mappings and connection details using the Get Pod Status endpoint. This request also supports checking multiple instance statuses simultaneously:data
with the list of object like:
primePortMapping
.
In case of an error,
installationFailure
will be set. Our system will attempt automatic retries, but issues related to the image or configuration may require further action.