Skip to main content

API Types

Katapult provides two distinct API endpoints designed for different use cases and access patterns.

Core API​

The Core API is Katapult's primary API interface that provides:

  • Full administrative access to all Katapult resources
  • Complete CRUD operations for virtual machines, storage, networking, and more
  • User, organization, and role-based access control
  • Designed for authenticated users and applications with proper authorization

Use the Core API when:

  • Automating infrastructure management tasks
  • Developing applications that require organization-level permissions

Public API​

The Public API offers a subset of functionality with:

  • Read-only access to certain public information
  • Limited operations that don't require authentication
  • Publicly available data like region information, pricing, or service status
  • No organization or user context required

Use the Public API when:

  • Displaying public information like available regions or instance types
  • Accessing data that doesn't require user authentication

Authentication Requirements​

API TypeAuthenticationAuthorization
Core APIRequired (API tokens)User, organization & role-based
Public APINot requiredPublic access

Base URLs​

Each API type has its own base URL:

  • Core API: https://api.katapult.io/core/v1
  • Public API: https://api.katapult.io/public/v1

Next Steps​