API Reference

This is a complete reference of Cloudkitty’s API.

API v1

• CloudKitty REST API (v1)
  • Collector
    • CollectorInfos
      • CollectorInfos.enabled
      • CollectorInfos.name
    • ServiceToCollectorMapping
      • ServiceToCollectorMapping.collector
      • ServiceToCollectorMapping.service
    • ServiceToCollectorMappingCollection
      • ServiceToCollectorMappingCollection.mappings
  • Info
    • CloudkittyMetricInfo
      • CloudkittyMetricInfo.metadata
      • CloudkittyMetricInfo.metric_id
      • CloudkittyMetricInfo.unit
    • CloudkittyMetricInfoCollection
  • Rating
    • CloudkittyModule
      • CloudkittyModule.description
      • CloudkittyModule.enabled
      • CloudkittyModule.hot_config
      • CloudkittyModule.module_id
      • CloudkittyModule.priority
    • CloudkittyModuleCollection
    • CloudkittyResource
      • CloudkittyResource.desc
      • CloudkittyResource.service
      • CloudkittyResource.volume
    • CloudkittyResourceCollection
  • Report
  • Storage
    • RatedResource
      • RatedResource.desc
      • RatedResource.service
      • RatedResource.volume
    • DataFrame
      • DataFrame.begin
      • DataFrame.end
      • DataFrame.resources
      • DataFrame.tenant_id
    • DataFrameCollection
• HashMap Module REST API
  • Service
    • Service.name
    • Service.service_id
  • ServiceCollection
    • ServiceCollection.services
  • Field
    • Field.field_id
    • Field.name
    • Field.service_id
  • FieldCollection
    • FieldCollection.fields
  • Mapping
    • Mapping.cost
    • Mapping.created_at
    • Mapping.created_by
    • Mapping.deleted
    • Mapping.deleted_by
    • Mapping.description
    • Mapping.end
    • Mapping.field_id
    • Mapping.group_id
    • Mapping.map_type
    • Mapping.mapping_id
    • Mapping.name
    • Mapping.service_id
    • Mapping.start
    • Mapping.tenant_id
    • Mapping.updated_by
    • Mapping.value
  • MappingCollection
    • MappingCollection.mappings
  • Threshold
    • Threshold.cost
    • Threshold.field_id
    • Threshold.group_id
    • Threshold.level
    • Threshold.map_type
    • Threshold.service_id
    • Threshold.tenant_id
    • Threshold.threshold_id
  • ThresholdCollection
    • ThresholdCollection.thresholds
  • Group
    • Group.group_id
    • Group.name
  • GroupCollection
    • GroupCollection.groups
• PyScripts Module REST API
  • Script
    • Script.checksum
    • Script.created_at
    • Script.created_by
    • Script.data
    • Script.deleted
    • Script.deleted_by
    • Script.description
    • Script.end
    • Script.name
    • Script.script_id
    • Script.start
    • Script.updated_by
  • ScriptCollection
    • ScriptCollection.scripts

API v2

• Dataframes endpoint
  • Add dataframes into the storage backend
  • Get dataframes from the storage backend
• Scope state endpoint
  • Get the status of several scopes
  • Reset the status of several scopes
  • Patch a scope
  • Create a scope
• Summary endpoint
  • Get a rating summary
• Task schedule endpoint
  • Create a reprocessing task
  • Retrieve a reprocessing task
  • Retrieve all reprocessing tasks
• Rating modules endpoint
  • Get the list of modules
  • Get one module
  • Update one module