Core instances

Core Instances

Core Instances from a project with backward pagination.

get

/v1/projects/{projectID}/core_instances

Authorizations

userproject

Path parameters

projectIDstring · uuidrequired

Parent project ID.

Query parameters

lastinteger

Limit to the last core instances.

beforestring

Paginate core instances before the given cursor.

namestring

Filter core instances with the given name.

environment_idstring

Filter core instances with the given environment ID.

tags_querystring

Filter core instances with the given tags query.

Example: tagone AND tagtwo

exclude_internalboolean

Exclude internal pipelines (health-check) from count.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/projects/{projectID}/core_instances' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "my-core-instance",
      "version": "v0.1.12",
      "status": "running",
      "metadata": {
        "aws.ami_id": "text",
        "aws.account_id": "text",
        "aws.hostname": "text",
        "aws.vpc_id": "text",
        "aws.private_ipv4": "text",
        "aws.public_ipv4": "text",
        "aws.ec2_instance_id": "text",
        "aws.ec2_instance_type": "text",
        "aws.az": "text"
      },
      "pipelinesCount": 1,
      "createdAt": "2025-03-12T04:25:03.214Z",
      "updatedAt": "2025-03-12T04:25:03.214Z",
      "tags": null,
      "environmentName": "default",
      "skipServiceCreation": false
    }
  ],
  "endCursor": "text",
  "count": 1
}

OK