Cosmic Admin API Reference

listPods

Lists all Pods.

Request parameters

Parameter NameDescriptionRequired
allocationstatelist pods by allocation statefalse
idlist Pods by IDfalse
keywordList by keywordfalse
namelist Pods by namefalse
pagefalse
pagesizefalse
showcapacitiesflag to display the capacity of the podsfalse
zoneidlist Pods by Zone IDfalse

Response Tags

Response NameDescription
idthe ID of the Pod
allocationstatethe allocation state of the Pod
endipthe ending IP for the Pod
gatewaythe gateway of the Pod
namethe name of the Pod
netmaskthe netmask of the Pod
startipthe starting IP for the Pod
zoneidthe Zone ID of the Pod
zonenamethe Zone name of the Pod
capacity(*)the capacity of the Pod
capacitytotalthe total capacity available
capacityusedthe capacity currently in use
clusteridthe Cluster ID
clusternamethe Cluster name
percentageallocatedthe percentage of capacity currently allocated
podidthe Pod ID
podnamethe Pod name
typethe capacity type
zoneidthe Zone ID
zonenamethe Zone name