Compute APIs

Creating and managing accounts, projects, and clients for development.

Retrieve compute usage metrics for a project

get

This endpoint provides the details about any compute resources being consumed by the project. This will return an array of the compute nodes found, their instance type and limits.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/containers

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/containers HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "created": "2025-12-16T22:08:17.734Z",
  "image_id": "text",
  "image": "text",
  "template": {
    "id": "text",
    "name": "text",
    "image": "text",
    "requires_image": true,
    "description": "text",
    "type": "website",
    "port": 1,
    "protocol": "http",
    "resolver": "http_hostname_header",
    "endpoint_url": "text",
    "documentation_url": "text",
    "required_features": {
      "dns": {
        "zone": "text"
      },
      "git": {
        "git_url": "text"
      },
      "oauth_client": {
        "name": "text",
        "token_auth_method": "text",
        "authorized_domains": [
          "text"
        ],
        "authorized_redirect_uris": [
          "text"
        ]
      },
      "app": {
        "name": "text",
        "logo_url": "text",
        "app_links": {
          "home_page_url": "text",
          "privacy_url": "text",
          "terms_url": "text"
        },
        "domains": [
          "text"
        ],
        "developers": [
          "text"
        ],
        "support_email": "text",
        "scopes": [
          "text"
        ]
      },
      "services": [
        "text"
      ]
    },
    "creation_date": "2025-12-16T22:08:17.734Z",
    "status": "active",
    "manifest_filename": "text",
    "default_machine_type": "text",
    "autoscale": true
  },
  "ports": [
    1
  ]
}

Runs a deployment to docker for the given project.

post

This will create and setup the organization (if not already) as well as deploy the project into the docker instance. After complete the docker instance will be available (but not yet bound) to any loadbalancer or port.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

The project ID

Query parameters

imagestringRequired

The image to deploy to this container, if applicable for the template.

template_idanyRequired

The template to use.

machineTypestringRequired

The type of machine to deploy, see /.metadata machine names for types of machine.

Default: m1.small

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/console/projects/{projectId}/containers/provision

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/containers/provision?image=text&machineType=m1.small HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Id": "text",
  "Name": "text"
}

Returns the git information for the project if it is active.

get

This endpoint enables a user to lookup and get key information about the git project linked to their console project. If the user has activated git on their project this will return the latest information included the git url, and connection options as well as stats.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/git

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/git HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "git": {
    "id": 1,
    "name": "text",
    "avatar_url": "text",
    "created_at": "2025-12-16T22:08:17.734Z",
    "updated_at": "2025-12-16T22:08:17.734Z",
    "last_activity_at": "2025-12-16T22:08:17.734Z",
    "path": "text",
    "path_with_namespace": "text",
    "repository_storage": "text",
    "description": "text",
    "default_branch": "text",
    "ssh_url_to_repo": "text",
    "http_url_to_repo": "text",
    "web_url": "text",
    "readme_url": "text",
    "license_url": "text",
    "topics": [
      "text"
    ],
    "owner": {
      "id": 1,
      "name": "text"
    },
    "namespace": {
      "id": 1,
      "name": "text",
      "path": "text",
      "kind": "group",
      "full_path": "text",
      "avatar_url": "text",
      "web_url": "text"
    },
    "shared_with_groups": [
      {
        "group_id": 1,
        "group_name": "text",
        "group_full_path": "text",
        "group_access_level": 1
      }
    ],
    "issues_enabled": true,
    "shared_runners_enabled": true,
    "group_runners_enabled": true,
    "runners_token": "text",
    "container_registry_image_prefix": "text",
    "open_issues_count": 1,
    "merge_requests_enabled": true,
    "archived": true,
    "container_registry_enabled": true,
    "jobs_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": true,
    "statistics": {
      "commit_count": 1,
      "storage_size": 1,
      "repository_size": 1,
      "wiki_size": 1,
      "lfs_objects_size": 1,
      "job_artifacts_size": 1,
      "pipeline_artifacts_size": 1,
      "packages_size": 1,
      "snippets_size": 1,
      "uploads_size": 1,
      "container_registry_size": 1,
      "languages": {
        "ANY_ADDITIONAL_PROPERTY": 1
      }
    }
  },
  "enabled": true
}

Enable Git for the project

post

This endpoint is made to enable git for the specific project so that the user can have a complete project for software development.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/console/projects/{projectId}/git

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/git HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": 1,
  "name": "text",
  "avatar_url": "text",
  "created_at": "2025-12-16T22:08:17.734Z",
  "updated_at": "2025-12-16T22:08:17.734Z",
  "last_activity_at": "2025-12-16T22:08:17.734Z",
  "path": "text",
  "path_with_namespace": "text",
  "repository_storage": "text",
  "description": "text",
  "default_branch": "text",
  "ssh_url_to_repo": "text",
  "http_url_to_repo": "text",
  "web_url": "text",
  "readme_url": "text",
  "license_url": "text",
  "topics": [
    "text"
  ],
  "owner": {
    "id": 1,
    "name": "text"
  },
  "namespace": {
    "id": 1,
    "name": "text",
    "path": "text",
    "kind": "group",
    "full_path": "text",
    "avatar_url": "text",
    "web_url": "text"
  },
  "shared_with_groups": [
    {
      "group_id": 1,
      "group_name": "text",
      "group_full_path": "text",
      "group_access_level": 1
    }
  ],
  "issues_enabled": true,
  "shared_runners_enabled": true,
  "group_runners_enabled": true,
  "runners_token": "text",
  "container_registry_image_prefix": "text",
  "open_issues_count": 1,
  "merge_requests_enabled": true,
  "archived": true,
  "container_registry_enabled": true,
  "jobs_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": true,
  "statistics": {
    "commit_count": 1,
    "storage_size": 1,
    "repository_size": 1,
    "wiki_size": 1,
    "lfs_objects_size": 1,
    "job_artifacts_size": 1,
    "pipeline_artifacts_size": 1,
    "packages_size": 1,
    "snippets_size": 1,
    "uploads_size": 1,
    "container_registry_size": 1,
    "languages": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  }
}

List the pipelines for git

get

This endpoint will return the pipelines that have been run ordered by date descending.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/git/pipelines

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/git/pipelines HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": 1,
    "status": "text",
    "project_id": 1,
    "source": "text",
    "created_at": "text",
    "updated_at": "text",
    "web_url": "text"
  }
]

Get the latest build from the git project

get

This endpoint will examine and find the latest build and get the general pipeline status.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/git/pipelines/latest

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/git/pipelines/latest HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": 1,
  "status": "text",
  "project_id": 1,
  "source": "text",
  "created_at": "text",
  "updated_at": "text",
  "web_url": "text"
}

List the steps performed in a specific pipeline

get

Will return the steps performed in the given pipeline and include which jobs have succeeded or failed.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/git/pipelines/latest/jobs

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/git/pipelines/latest/jobs HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "stage": "text",
    "jobs": [
      {
        "id": 1,
        "status": "text",
        "stage": "text",
        "name": "text",
        "created_at": "text",
        "updated_at": "text",
        "started_at": "text",
        "finished_at": "text",
        "duration": 1,
        "queued_duration": 1,
        "web_url": "text"
      }
    ]
  }
]

Returns the available docker images for this project.

get

Will return any configured docker images for this project.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/images

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/images HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "name": "text",
    "path": "text",
    "location": "text",
    "image_id": "text",
    "revision": "text",
    "created_at": "2025-12-16T22:08:17.734Z",
    "total_size": 1
  }
]

Returns the latest docker project image

get

Will return the latest docker project image

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/images/latest

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/images/latest HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "name": "text",
  "path": "text",
  "location": "text",
  "image_id": "text",
  "revision": "text",
  "created_at": "2025-12-16T22:08:17.734Z",
  "total_size": 1
}

Examines the projects current container and sees if ingress is enabled and its status.

get

In order for a project to be accessible externally there must be a configured ingress into the container. This will return the current status (dns, ip, routing) so that a person can see if there needs to be a configuration change or activation or disable of this ingress.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

The project ID

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/ingress

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/ingress HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "status": "active",
  "dns": {
    "active": true,
    "zone": "text",
    "name": "text",
    "ip": {
      "type": "private",
      "address": "text"
    }
  },
  "bindings": [
    {
      "server": "text",
      "port": 1,
      "weight": 1
    }
  ]
}

Register the DNS entry for the container.

post

Given a specific project will register the public ip for later use by the ingress.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

The project ID

Query parameters

wait_msinteger · int32Optional

Wait until the server itself sees the DNS update useful to block until DNS is resolved.

Default: 10000

Responses

200

OK

No content

401

Unauthorized

*/*

post

/console/projects/{projectId}/ingress/dns

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/ingress/dns HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Publish access to the container over the configured protocol

post

Given a specific project will examine the template associated and configure the instance so it can be connected to through the public ingress. This could mean exposing the instance over HTTPS or in other instances for example mongo, the default mongo port.

If your corporation has a default security policy, firewall rules will still apply so that you "public" is still effectively private.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

The project ID

Responses

200

OK

No content

401

Unauthorized

*/*

post

/console/projects/{projectId}/ingress/public

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/ingress/public HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Ensures we can access the project over the specific port via https

post

This will create and setup the organization (if not already) as well as deploy the project into the docker instance. After complete the docker instance will be available (but not yet bound) to any loadbalancer or port.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

The project ID

portinteger · int32Required

The port to ingress over https

Responses

200

OK

No content

401

Unauthorized

*/*

post

/console/projects/{projectId}/ingress/{port}/https

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/ingress/{port}/https HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content