Koyeb Usages API

openapi: 3.2.0
info:
  title: Koyeb Rest Usages API
  description: 'The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests.

    '
  version: 1.0.0
servers:
- url: https://app.koyeb.com
security:
- Bearer: []
tags:
- name: Usages
paths:
  /v1/usages:
    get:
      summary: Get organization usage
      operationId: GetOrganizationUsage
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationUsageReply'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      parameters:
      - name: starting_time
        description: The starting time of the period to get data from
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: ending_time
        description: The ending time of the period to get data from
        in: query
        required: false
        schema:
          type: string
          format: date-time
      tags:
      - Usages
  /v1/usages/details:
    get:
      summary: Get organization usage details
      operationId: GetOrganizationUsageDetails
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationUsageDetailsReply'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      parameters:
      - name: starting_time
        description: The starting time of the period to get data from
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: ending_time
        description: The ending time of the period to get data from
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: limit
        description: (Optional) The number of items to return
        in: query
        required: false
        schema:
          type: string
      - name: offset
        description: (Optional) The offset in the list of item to return
        in: query
        required: false
        schema:
          type: string
      - name: order
        description: (Optional) Sorts the list in the ascending or the descending order
        in: query
        required: false
        schema:
          type: string
      - name: Accept
        description: If defined with the value 'text/csv', a csv file is returned
        in: header
        required: false
        schema:
          type: string
      tags:
      - Usages
components:
  schemas:
    google.protobuf.Any:
      type: object
      properties:
        '@type':
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
      additionalProperties: {}
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    DatabaseUsageDetails:
      type: object
      properties:
        organization_id:
          type: string
        app_id:
          type: string
        app_name:
          type: string
        service_id:
          type: string
        service_name:
          type: string
        compute_time_seconds:
          type: integer
          format: int64
        data_storage_megabytes_hour:
          type: integer
          format: int64
        started_at:
          type: string
          format: date-time
        terminated_at:
          type: string
          format: date-time
    RegionUsage:
      type: object
      properties:
        instances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/InstanceUsage'
    PeriodUsage:
      type: object
      properties:
        starting_time:
          type: string
          format: date-time
        ending_time:
          type: string
          format: date-time
        apps:
          type: array
          items:
            $ref: '#/components/schemas/AppUsage'
    GetOrganizationUsageDetailsReply:
      type: object
      properties:
        usage_details:
          type: array
          items:
            $ref: '#/components/schemas/UsageDetails'
          title: The collection of usage instances
        database_details:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseUsageDetails'
          title: The collection of database deployments used during the month
        limit:
          type: integer
          format: int64
          title: The limit in the request
        offset:
          type: integer
          format: int64
          title: The offset in the request
        count:
          type: integer
          format: int64
          title: The total number of items
        order:
          type: string
          title: The order in the request
    UsageDetails:
      type: object
      properties:
        organization_id:
          type: string
        instance_id:
          type: string
        app_id:
          type: string
        app_name:
          type: string
        service_id:
          type: string
        service_name:
          type: string
        regional_deployment_id:
          type: string
        region:
          type: string
        deployment_id:
          type: string
        instance_type:
          type: string
        duration_seconds:
          type: integer
          format: int64
        started_at:
          type: string
          format: date-time
        terminated_at:
          type: string
          format: date-time
    Usage:
      type: object
      properties:
        organization_id:
          type: string
        periods:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PeriodUsage'
    AppUsage:
      type: object
      properties:
        app_id:
          type: string
        app_name:
          type: string
        services:
          type: array
          items:
            $ref: '#/components/schemas/ServiceUsage'
        databases:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseUsage'
    DatabaseUsage:
      type: object
      properties:
        service_id:
          type: string
        service_name:
          type: string
        compute_time_seconds:
          type: integer
          format: int64
        data_storage_megabytes_hours:
          type: integer
          format: int64
    InstanceUsage:
      type: object
      properties:
        duration_seconds:
          type: integer
          format: int64
    ServiceUsage:
      type: object
      properties:
        service_id:
          type: string
        service_name:
          type: string
        regions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RegionUsage'
    GetOrganizationUsageReply:
      type: object
      properties:
        usage:
          $ref: '#/components/schemas/Usage'
          title: The computed usage of instances per month
    google.rpc.Status:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
x-tagGroups:
- name: Introduction
  tags:
  - intro
- name: API
  tags:
  - Profile
  - Sessions
  - Users
  - organization
  - Projects
  - OrganizationMembers
  - OrganizationInvitations
  - OrganizationConfirmations
  - Subscriptions
  - Coupons
  - Credentials
  - Secrets
  - activity
  - Apps
  - Services
  - Deployments
  - Archives
  - RegionalDeployments
  - Instances
  - Domains
  - PersistentVolumes
  - Snapshots
  - Compose
  - Repositories
  - Logs
  - Metrics
  - Catalog
  - CatalogRegions
  - CatalogInstances
  - Usages
  - Summary
  - DockerHelper