---
id: telemetry-instance-list
title: List instances
description: List compute instances for an application.
sidebar_label: List instances
hide_title: true
hide_table_of_contents: true
api: >-
  eJztV9tu20gM/ZUBn1qsLFvOBa3esptu4UW3KFovtkAaFGOJsaedW2dGbgxD/17M6GLJlt2k2cfNiyORIjmHhxxyCznazDDtmJKQwhtmHcmU0IVDwqR1VGZoyZ0yhEpCteYso143hgiURhMeZjmk4JCjQGc2afNdypl1EIGjSwvpDcwae3AbgaaGCnRovGgLzHv/VqDZQASSCoQUOu4+sxwisNkKBYV0C26jvQaTDpdooIzA4LeCGcwhdabAaO9cVztTZHbtg8d7KjRHSJMyGnZvM6XxMY7vKLcHnj94K2R2TZ59X6EkttBaGYc5WWyINmrNcjTPHxZQjpqrjUDpnhzVdWvqvwnNolmz7Bha1hkmlw8BqzKznyKw62yUwDHnnAnmnobH3/SeiUIQWYgFGqLuiEFbcGf7x59MytsILGaFYW4TiLtAatBcFW4F6c2tFxu0WkmL1kcynUz8T99bUwjEF4j3kCnpUDqv2SH9+Iv16tvDg6nFF8z8kbXxRehY5ayOuaNIjaEeKeZQ2J8baCrX53EofZ3gfibvm+hkoi2rQWmf44MqPutW0wyP2NfKdSQLpThSGSSOOhyMm9NCZqvPjolheY6OMv4IAN/SI5aoyVbMYeYKM6zABF3ibBj+xvo8CAYUtGFr6nCmT0mvpR0UZ7oYRlSgUGYz8E0ZgWOOV+pVaNc1UkOy8PKO8arp70M59IW/jt7X5eQjaSuxw/WbPdoCGyWwR1UQmyut4ZCgSZePyQH9kh7bpg256hZS8wlMIaXHY49HMJ1Mz0aT6Wh6Np+cp8nLNLn4bTJJJxPoMarPmU4IoyTWRuVFFi7ccIRYbN62Ae2zCe5fXEKHQUAFGyXTs/OL8LpHHnBnsWCZUdBjDSQvp3Fy+SJO4gT6jAGmR8nL6Si5fDFKRkmM2TT2JDGScqjZM92RBRLymv0Ope+InZyfTkDp/yI4//jxsGn+wZm/rtAYZUjbY0leIHGKMLmmnOWESV04ogwRzFoml2Q3Zzyp0e7ujxsQaC1dYphietXfCIaqK8T99M78jvqLZsD+cd8Vpk1ptWPaqxDQrqiqE1SohaHFP68pL7B3tCpdhFnSQlLWLi6G0uavdDQHaWMyD+DLpR8smbUFEiWJWyG5ejcjluX4f75+nq+a9m/U8k9lBHVHcjZfIeFq2U51Vfr8tOcTwNXSJySA/90oufTzvjfWonCzfyAY1/13nIxz6jB0vM6hQBTWEUFdtqqNkU/gFUde8xNAeVs2tBHoVsq3qyUGHGsH7a0RhemyWRQKwyGFlXPapuMx1SyWBeeaU+f9xJkS0J3RPniGVFh1J7UWdG+oGR3DuBCUIKr/aVCFv/6dhxuKyTsVQEZjK4In8ST2Hb1J2LxJWLhylXWCBq7Ww2rYsNrNCvYG0e2O8Y/bxerjOLx3Y80pCwNPwGpbI3qzu4dvI1gp6/y77XZBLf5jeFn619Vk7XHOmaULfmxg7sb57H1da8/J4Zo1GNdX3AytdzVxIQz6D/f/4A3rRCydXe8Xo3jcRnUilP0t71dR6a1Sp47eXd1+0dnJ9emE72Zz27m99Q+Geb9hn4pghTTHqgdVH11lGeruVwc3g7fSdpXXr+Z+UuqX/V6ZB+tNo5ebju3tttKYq68oyxKayJ1/rrrYD6Ov8oU=
sidebar_class_name: get api-method
info_path: docs/api/telemetry
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/telemetry-instance-list'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List instances"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/instance"}
  context={"endpoint"}
>

</MethodEndpoint>

List compute instances for an application.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"application_id","schema":{"type":"integer"},"required":true,"description":"Application ID.","example":1},{"in":"query","name":"scope_id","schema":{"type":"integer"},"required":false,"description":"Scope ID (when supported by provider).","example":1},{"in":"query","name":"deployment_id","schema":{"type":"integer"},"required":false,"description":"Deployment ID (when supported by provider).","example":1},{"in":"query","name":"service_id","schema":{"type":"string"},"required":false,"description":"Service ID.","example":"svc-1"},{"in":"query","name":"limit","schema":{"type":"integer"},"required":false,"description":"Maximum number of results.","example":100}]}
>

</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Instance list.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"instance_id":{"type":"string"},"application":{"type":"string"},"application_id":{"type":"integer"},"scope_id":{"type":"integer"},"deployment_id":{"type":"integer"},"namespace":{"type":"integer"},"spot":{"type":"boolean"},"state":{"type":"string"},"launch_time":{"type":"string"},"details":{"type":"object","properties":{"instanceName":{"type":"string"},"architecture":{"type":"string"},"imageId":{"type":"string"},"instanceType":{"type":"string"},"privateIp":{"type":"string"},"privateDns":{"type":"string"},"cpu":{"type":"integer"},"memory":{"type":"string"}},"title":"instanceDetails"}},"title":"instance"}},"filters":{"type":"object"}},"title":"instanceListResponse"},"example":{"results":[{"instance_id":"i-1","application":"myApp","application_id":1,"scope_id":1,"deployment_id":1,"namespace":2,"spot":false,"state":"running","launch_time":"2023-02-23T04:19:15+00:00","details":{"instanceName":"deployment-1.production.myApp.myNamespace","architecture":"x86","imageId":"ami-123456","instanceType":"t3.micro","privateIp":"192.168.1.1","privateDns":"ip-192-168-1-1.ec2.internal","cpu":2,"memory":"1 GiB"}}],"filters":{"application_id":1,"scope_id":1}}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"error":{"type":"array","items":{"type":"object","properties":{"instancePath":{"type":"string"},"message":{"type":"string"}}}}},"title":"telemetryError"},"examples":{"missingScope":{"value":{"message":"scope is required"}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"error":{"type":"array","items":{"type":"object","properties":{"instancePath":{"type":"string"},"message":{"type":"string"}}}}},"title":"telemetryError"},"examples":{"invalidLogFormat":{"value":{"message":"The log provider is reporting logs in the wrong format","error":[{"instancePath":"/results/1/datetime","message":"must match format \"date-time\""}]}}}}}}}}
>

</StatusCodes>

