swagger: '2.0'
info:
  title: Koyeb Rest activity Summary 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
host: app.koyeb.com
schemes:
- https
security:
- Bearer: []
tags:
- name: Summary
paths:
  /v1/organizations/{organization_id}/summary:
    get:
      summary: Get organization usage summary
      operationId: GetOrganizationSummary
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/GetOrganizationSummaryReply'
        '400':
          description: Validation error
          schema:
            $ref: '#/definitions/ErrorWithFields'
        '401':
          description: Returned when the token is not valid.
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Returned when the user does not have permission to access the resource.
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Returned when the resource does not exist.
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Returned in case of server error.
          schema:
            $ref: '#/definitions/Error'
        '503':
          description: Service is unavailable.
          schema:
            $ref: '#/definitions/Error'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/google.rpc.Status'
      parameters:
      - name: organization_id
        description: Organization ID
        in: path
        required: true
        type: string
      tags:
      - Summary
definitions:
  ServiceSummary:
    type: object
    properties:
      total:
        type: string
        format: int64
        title: Total number of services
      by_status:
        type: object
        additionalProperties:
          type: string
          format: int64
        title: Number of services grouped by status
  NeonPostgresSummary:
    type: object
    properties:
      total:
        type: string
        format: int64
        title: Total number of databases
      by_instance_type:
        type: object
        additionalProperties:
          type: string
          format: int64
        title: Number of databases grouped by instance type
  DomainsSummary:
    type: object
    properties:
      total:
        type: string
        format: int64
        title: Total number of domains
      by_status:
        type: object
        additionalProperties:
          type: string
          format: int64
        title: Number of domains grouped by status
  InstancesSummary:
    type: object
    properties:
      total:
        type: string
        format: int64
        title: Total number of instances
      by_type:
        type: object
        additionalProperties:
          type: string
          format: int64
        title: Number of instances grouped by type
  GetOrganizationSummaryReply:
    type: object
    properties:
      summary:
        $ref: '#/definitions/OrganizationSummary'
        title: Organization usage summary
  MembersSummary:
    type: object
    properties:
      total:
        type: string
        format: int64
        title: Number of members
      invitations_by_status:
        type: object
        additionalProperties:
          type: string
          format: int64
        title: Number of invitations grouped by status
  SecretsSummary:
    type: object
    properties:
      total:
        type: string
        format: int64
        title: Total number of secrets
      by_type:
        type: object
        additionalProperties:
          type: string
          format: int64
        title: Number of secrets grouped by type
  google.rpc.Status:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/google.protobuf.Any'
  OrganizationSummary:
    type: object
    properties:
      organization_id:
        type: string
      instances:
        $ref: '#/definitions/InstancesSummary'
      apps:
        $ref: '#/definitions/AppsSummary'
      services:
        type: object
        additionalProperties:
          $ref: '#/definitions/ServiceSummary'
        title: Number of services grouped by type
      domains:
        $ref: '#/definitions/DomainsSummary'
      secrets:
        $ref: '#/definitions/SecretsSummary'
      neon_postgres:
        $ref: '#/definitions/NeonPostgresSummary'
      members:
        $ref: '#/definitions/MembersSummary'
  ErrorWithFields:
    type: object
    properties:
      status:
        type: integer
        format: int32
      code:
        type: string
      message:
        type: string
      fields:
        type: array
        items:
          $ref: '#/definitions/ErrorField'
  AppsSummary:
    type: object
    properties:
      total:
        type: string
        format: int64
        title: Total number of apps
      by_status:
        type: object
        additionalProperties:
          type: string
          format: int64
        title: Number of apps grouped by status
  google.protobuf.Any:
    type: object
    properties:
      '@type':
        type: string
    additionalProperties: {}
  ErrorField:
    type: object
    properties:
      field:
        type: string
      description:
        type: string
  Error:
    type: object
    properties:
      status:
        type: integer
        format: int32
      code:
        type: string
      message:
        type: string
securityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
x-tagGroups:
- name: Introduction
  tags:
  - intro
- name: API
  tags:
  - Profile
  - Sessions
  - Users
  - organization
  - 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