← Back

Resource

API for resource operations

Version: 0.1.0

Server

  • URL: https://api.kopernik.us/v0
    • Kopernik.us API server

Schemas

ResourceType

Type of the cloud resource

Type: enum

Values:

  • account
  • blockstorage
  • firewall
  • image
  • kubernetes
  • machine
  • machinetype
  • region
  • sshkey
  • vpc

Resource

Cloud resource instance

Type: object

Properties:

Name Type Required Description
type ResourceType ✅
providerUid ProviderId ✅
regionUid string ❌ Cloud region identifier; if not specified, the resource is global
accountUid string ❌ Cloud account identifier; if not specified, the resource is global
uid string ✅ Unique identifier of the cloud resource instance
grid string ✅ Globally unique identifier of the cloud resource instance; Format: grid:<providerUid>:<type>:[regionUid]:[accountUid]:<uid>