Skip to main content
Version: 1.0.0

Katapult Core API

Welcome to the documentation for the Katapult Core API

Authentication​

Security Scheme Type:

oauth2

OAuth Flow (authorizationCode):

Token URL: https://identity.krystal.io/oauth2/token

Authorization URL: https://identity.krystal.io/oauth2/auth

Refresh URL: https://identity.krystal.io/oauth2/token

Scopes:

  • api.katapult.io/core/v1/address_lists: Manage address lists

  • api.katapult.io/core/v1/address_lists:read: Read-only access to address lists

  • api.katapult.io/core/v1/api_tokens: Manage API tokens

  • api.katapult.io/core/v1/api_tokens:read: Read-only access to API tokens

  • api.katapult.io/core/v1/disk_backup_policies: Manage disk backup policies

  • api.katapult.io/core/v1/disk_backup_policies:read: Read-only access to disk backup policies

  • api.katapult.io/core/v1/certificates:read: Read-only access to certificates

  • api.katapult.io/core/v1/disks: Manage disks

  • api.katapult.io/core/v1/disks:read: Read-only access to disks

  • api.katapult.io/core/v1/disk_templates: Manage disk templates

  • api.katapult.io/core/v1/disk_templates:read: Read-only access to disk templates

  • api.katapult.io/core/v1/file_storage_volumes: Manage file storage volumes

  • api.katapult.io/core/v1/file_storage_volumes:read: Read-only access to file storage volumes

  • api.katapult.io/core/v1/ip_addresses: Manage IP addresses

  • api.katapult.io/core/v1/ip_addresses:read: Read-only access to IP addresses

  • api.katapult.io/core/v1/object_storage: Manage object storage

  • api.katapult.io/core/v1/object_storage:read: Read-only access to object storage

  • api.katapult.io/core/v1/organizations:read: Read-only access to organizations

  • api.katapult.io/core/v1/organizations:delete: Delete organizations

  • api.katapult.io/core/v1/managed_organizations: Manage managed organizations

  • api.katapult.io/core/v1/managed_organizations:delete: Delete managed organizations

  • api.katapult.io/core/v1/security_groups: Manage security groups

  • api.katapult.io/core/v1/security_groups:read: Read-only access to security groups

  • api.katapult.io/core/v1/tags: Manage tags

  • api.katapult.io/core/v1/tags:read: Read-only access to tags

  • api.katapult.io/core/v1/tasks:read: Read-only access to tasks

  • api.katapult.io/core/v1/trash_objects:read: Read-only access to objects in the trash

  • api.katapult.io/core/v1/trash_objects:purge: Purge items from the trash

  • api.katapult.io/core/v1/trash_objects:restore: Restore items from the trash

  • api.katapult.io/core/v1/dns: Manage DNS zones/records

  • api.katapult.io/core/v1/dns:read: Read-only access to DNS zones/records

  • api.katapult.io/core/v1/load_balancers: Manage load balancers

  • api.katapult.io/core/v1/load_balancers:read: Read-only access to load balancers

  • api.katapult.io/core/v1/virtual_machines: Manage virtual machines

  • api.katapult.io/core/v1/virtual_machines:read: Read-only access to virtual machines

  • api.katapult.io/core/v1/virtual_machines:power_actions: Start & stop virtual machines

  • api.katapult.io/core/v1/virtual_machines:console: Access virtual machine consoles

  • api.katapult.io/core/v1/virtual_machines:authorized_keys: Access virtual machine authorized keys

  • api.katapult.io/core/v1/virtual_machines:network_interfaces: Access virtual machine network interfaces

  • api.katapult.io/core/v1/virtual_machine_groups: Manage virtual machine groups

  • api.katapult.io/core/v1/virtual_machine_groups:read: Read-only access to virtual machine groups

  • api.katapult.io/core/v1/virtual_networks: Manage virtual networks

  • api.katapult.io/core/v1/virtual_networks:read: Read-only access to virtual networks