Koyeb activity API
The activity API from Koyeb — 3 operation(s) for activity.
OpenAPI Specification
swagger: '2.0'
info:
title: Koyeb Rest activity 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: activity
paths:
/v1/account/activities:
get:
operationId: GetAccountActivities
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ActivityList'
'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: limit
in: query
required: false
type: string
- name: offset
in: query
required: false
type: string
tags:
- activity
/v1/activities:
get:
summary: List Activities
operationId: ListActivities
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ActivityList'
'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: limit
in: query
required: false
type: string
- name: offset
in: query
required: false
type: string
- name: types
description: (Optional) Filter on object type
in: query
required: false
type: array
items:
type: string
collectionFormat: multi
tags:
- activity
/v1/notifications:
get:
summary: List Notifications
operationId: ListNotifications
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/NotificationList'
'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: limit
in: query
required: false
type: string
- name: offset
in: query
required: false
type: string
- name: mark_read
in: query
required: false
type: string
- name: mark_seen
in: query
required: false
type: string
- name: unread
in: query
required: false
type: string
- name: unseen
in: query
required: false
type: string
tags:
- activity
definitions:
NotificationList:
type: object
properties:
notifications:
type: array
items:
$ref: '#/definitions/Notification'
limit:
type: integer
format: int64
offset:
type: integer
format: int64
count:
type: integer
format: int64
is_read:
type: boolean
is_seen:
type: boolean
unread:
type: integer
format: int64
unseen:
type: integer
format: int64
ActivityList:
type: object
properties:
activities:
type: array
items:
$ref: '#/definitions/Activity'
limit:
type: integer
format: int64
offset:
type: integer
format: int64
has_next:
type: boolean
google.rpc.Status:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
$ref: '#/definitions/google.protobuf.Any'
Object:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
metadata:
type: object
deleted:
type: boolean
Activity:
type: object
properties:
id:
type: string
actor:
$ref: '#/definitions/Object'
object:
$ref: '#/definitions/Object'
verb:
type: string
metadata:
type: object
created_at:
type: string
format: date-time
ErrorWithFields:
type: object
properties:
status:
type: integer
format: int32
code:
type: string
message:
type: string
fields:
type: array
items:
$ref: '#/definitions/ErrorField'
google.protobuf.Any:
type: object
properties:
'@type':
type: string
additionalProperties: {}
Notification:
type: object
properties:
id:
type: string
activity:
$ref: '#/definitions/Activity'
is_read:
type: boolean
is_seen:
type: boolean
created_at:
type: string
format: date-time
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