Skip to main content
GET
/
instances
/
{instance}
Get instance
curl --request GET \
  --url https://app.laravel.cloud/api/instances/{instance} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "type": "instances",
    "attributes": {
      "name": "<string>",
      "type": "app",
      "size": "flex.c-1vcpu-256mb",
      "scaling_type": "none",
      "min_replicas": 123,
      "max_replicas": 123,
      "uses_scheduler": true,
      "scaling_cpu_threshold_percentage": 123,
      "scaling_memory_threshold_percentage": 123,
      "created_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "environment": {
        "data": {
          "type": "environments",
          "id": "<string>"
        }
      },
      "backgroundProcesses": {
        "data": [
          {
            "type": "<string>",
            "id": "<string>"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

instance
string
required

The instance identifier

Response

InstanceResource

data
object
required