Koyeb
Koyeb is a developer-friendly serverless platform for deploying apps globally. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests for managing apps, services, deployments, and secrets.
1 APIs
0 Features
Cloud PlatformDeploymentPaaSServerless
APIs
Koyeb API
The Koyeb API provides programmatic access to manage apps, services, deployments, secrets, domains, regions, organizations and billing on the Koyeb serverless platform.
Collections
Koyeb Rest API
OPENPricing Plans
Rate Limits
FinOps
Koyeb Finops
FINOPSResources
👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
📝
Signup
Signup
🔗
LlmsText
LlmsText
Sources
opencollection: 1.0.0
info:
name: Koyeb Rest API
version: 1.0.0
items:
- info:
name: Repositories
type: folder
items:
- info:
name: List Branches
type: http
http:
method: GET
url: '{{baseUrl}}/v1/git/branches'
params:
- name: repository_id
value: ''
type: query
description: (Optional) Filter on one repository.
- name: name
value: ''
type: query
description: '(Optional) Filter on branch name using a fuzzy search.
Repository filter is required to enable this filter.'
- name: limit
value: ''
type: query
description: (Optional) The number of items to return.
- name: offset
value: ''
type: query
description: (Optional) The offset in the list of item to return.
docs: List Branches
- info:
name: List Repositories
type: http
http:
method: GET
url: '{{baseUrl}}/v1/git/repositories'
params:
- name: name
value: ''
type: query
description: (Optional) Filter on repository name using a fuzzy search.
- name: name_search_op
value: ''
type: query
description: (Optional) Define search operation for repository name. Accept either "fuzzy" or "equality", use "fuzzy"
by default.
- name: limit
value: ''
type: query
description: (Optional) The number of items to return.
- name: offset
value: ''
type: query
description: (Optional) The offset in the list of item to return.
docs: List Repositories
- info:
name: Resync Organization
type: http
http:
method: POST
url: '{{baseUrl}}/v1/git/sync/organization/:organization_id'
params:
- name: organization_id
value: ''
type: path
docs: Resync Organization
- info:
name: Users
type: folder
items:
- info:
name: Delete user
type: http
http:
method: DELETE
url: '{{baseUrl}}/v1/users/:id'
params:
- name: id
value: ''
type: path
description: The id of the user
docs: Delete user
- info:
name: V2 Delete user
type: http
http:
method: DELETE
url: '{{baseUrl}}/v2/users/:id'
params:
- name: id
value: ''
type: path
description: The id of the user
docs: V2 Delete user
- info:
name: activity
type: folder
items:
- info:
name: GetAccountActivities
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/activities'
params:
- name: limit
value: ''
type: query
- name: offset
value: ''
type: query
- info:
name: List Activities
type: http
http:
method: GET
url: '{{baseUrl}}/v1/activities'
params:
- name: limit
value: ''
type: query
- name: offset
value: ''
type: query
- name: types
value: ''
type: query
description: (Optional) Filter on object type
docs: List Activities
- info:
name: List Notifications
type: http
http:
method: GET
url: '{{baseUrl}}/v1/notifications'
params:
- name: limit
value: ''
type: query
- name: offset
value: ''
type: query
- name: mark_read
value: ''
type: query
- name: mark_seen
value: ''
type: query
- name: unread
value: ''
type: query
- name: unseen
value: ''
type: query
docs: List Notifications
- info:
name: Profile
type: folder
items:
- info:
name: Begin a session with iDenfy, emit an authToken
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/idenfy'
docs: Begin a session with iDenfy, emit an authToken
- info:
name: 'ClearIdenfyVerificationResult marks the current result for idenfy as
superseded'
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/idenfy'
docs: 'ClearIdenfyVerificationResult marks the current result for idenfy as
superseded'
- info:
name: Get the login method for an email address
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/login_method'
params:
- name: email
value: ''
type: query
docs: Get the login method for an email address
- info:
name: Get OAuth Providers
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/oauth'
params:
- name: action
value: ''
type: query
description: Which authentication flow is being initiated
- name: metadata
value: ''
type: query
description: 'A small (limited to 400 characters) string of arbitrary metadata which will
be encoded in the state'
docs: Get OAuth Providers
- info:
name: Authenticate using OAuth
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/oauth'
headers:
- name: seon-fp
value: ''
docs: Authenticate using OAuth
- info:
name: Get Current Organization
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/organization'
docs: Get Current Organization
- info:
name: List User Organization Invitations
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/organization_invitations'
params:
- name: limit
value: ''
type: query
description: (Optional) The number of items to return
- name: offset
value: ''
type: query
description: (Optional) The offset in the list of item to return
- name: statuses
value: ''
type: query
description: (Optional) Filter on organization invitation statuses
docs: List User Organization Invitations
- info:
name: Get User Organization Invitation
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/organization_invitations/:id'
params:
- name: id
value: ''
type: path
description: The id of the organization invitation to get
docs: Get User Organization Invitation
- info:
name: Accept Organization Invitation
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/organization_invitations/:id/accept'
params:
- name: id
value: ''
type: path
description: The id of the organization invitation to accept
docs: Accept Organization Invitation
- info:
name: Decline Organization Invitation
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/organization_invitations/:id/decline'
params:
- name: id
value: ''
type: path
description: The id of the organization invitation to decline
docs: Decline Organization Invitation
- info:
name: List User Organizations
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/organizations'
params:
- name: limit
value: ''
type: query
description: (Optional) Define pagination limit
- name: offset
value: ''
type: query
description: (Optional) Define pagination offset
- name: order
value: ''
type: query
description: (Optional) Sorts the list in the ascending or the descending order
- name: search
value: ''
type: query
description: '(Optional) Fuzzy case-insensitive search based on organization name or
organization id'
- name: statuses
value: ''
type: query
description: (Optional) Only return organizations which status match one in the list
docs: List all organizations that the current user is a member of.
- info:
name: Get Current User
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/profile'
headers:
- name: seon-fp
value: ''
docs: Get Current User
- info:
name: Update User
type: http
http:
method: PUT
url: '{{baseUrl}}/v1/account/profile'
params:
- name: update_mask
value: ''
type: query
docs: Update User
- info:
name: Update User
type: http
http:
method: PATCH
url: '{{baseUrl}}/v1/account/profile'
params:
- name: update_mask
value: ''
type: query
docs: Update User
- info:
name: Resend Email Verification
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/resend_validation'
docs: Resend Email Verification
- info:
name: Reset Password
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/reset_password'
docs: Reset Password
- info:
name: GetUserSettings
type: http
http:
method: GET
url: '{{baseUrl}}/v1/account/settings'
- info:
name: UpdateUserSettings
type: http
http:
method: PATCH
url: '{{baseUrl}}/v1/account/settings'
- info:
name: Signup
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/signup'
headers:
- name: seon-fp
value: ''
docs: Signup
- info:
name: Update Password
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/update_password'
headers:
- name: seon-fp
value: ''
docs: Update Password
- info:
name: Validate
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/validate/:id'
headers:
- name: seon-fp
value: ''
params:
- name: id
value: ''
type: path
docs: Validate
- info:
name: Update User V2
type: http
http:
method: PUT
url: '{{baseUrl}}/v2/account/profile'
params:
- name: update_mask
value: ''
type: query
docs: Update User V2
- info:
name: Update User V2
type: http
http:
method: PATCH
url: '{{baseUrl}}/v2/account/profile'
params:
- name: update_mask
value: ''
type: query
docs: Update User V2
- info:
name: invite
type: folder
items:
- info:
name: CreateInvite
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/invite'
- info:
name: billing
type: folder
items:
- info:
name: 'Experimental: Has unpaid invoices'
type: http
http:
method: GET
url: '{{baseUrl}}/v1/billing/has_unpaid_invoices'
docs: 'WARNING: Please don''t use the following method.
Koyeb doesn''t guarantee backwards compatible breaking change and reserve
the right to completely drop it without notice. USE AT YOUR OWN RISK.'
- info:
name: Manage
type: http
http:
method: GET
url: '{{baseUrl}}/v1/billing/manage'
- info:
name: 'Experimental: Fetch next invoice'
type: http
http:
method: GET
url: '{{baseUrl}}/v1/billing/next_invoice'
docs: 'WARNING: Please don''t use the following method.
Koyeb doesn''t guarantee backwards compatible breaking change and reserve
the right to completely drop it without notice. USE AT YOUR OWN RISK.'
- info:
name: organization
type: folder
items:
- info:
name: Fetch Github Installation configuration
type: http
http:
method: GET
url: '{{baseUrl}}/v1/github/installation'
docs: Fetch Github Installation configuration
- info:
name: Start Github Installation
type: http
http:
method: POST
url: '{{baseUrl}}/v1/github/installation'
docs: Start Github Installation
- info:
name: Create Organization
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organizations'
docs: Create Organization
- info:
name: Get Organization
type: http
http:
method: GET
url: '{{baseUrl}}/v1/organizations/:id'
params:
- name: id
value: ''
type: path
docs: Get Organization
- info:
name: Update Organization
type: http
http:
method: PUT
url: '{{baseUrl}}/v1/organizations/:id'
params:
- name: id
value: ''
type: path
- name: update_mask
value: ''
type: query
docs: Update Organization
- info:
name: Update Organization
type: http
http:
method: PATCH
url: '{{baseUrl}}/v1/organizations/:id'
params:
- name: id
value: ''
type: path
- name: update_mask
value: ''
type: query
docs: Update Organization
- info:
name: Delete an Organization
type: http
http:
method: DELETE
url: '{{baseUrl}}/v1/organizations/:id'
params:
- name: id
value: ''
type: path
docs: Delete an Organization
- info:
name: CreateAccessToken
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organizations/:id/access_token'
params:
- name: id
value: ''
type: path
description: Organization id for ephemeral credential
docs: 'CreateAccessToken creates a short-lived access token in the scope of the
specified organization, provided the user making the request is part of
said organization.
It''s possible to specify a validity for the token, which defaults to 1h
and must be no more than 24h. The format is `<number>s`, where `<number>`
is a floating point in seconds (so `123.456789012s` means 123 seconds and
456789012 nanoseconds). See:
https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Duration.html.'
- info:
name: Deactivate an Organization
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organizations/:id/deactivate'
params:
- name: id
value: ''
type: path
docs: Deactivate an Organization
- info:
name: Update Organization Name
type: http
http:
method: PUT
url: '{{baseUrl}}/v1/organizations/:id/name'
params:
- name: id
value: ''
type: path
docs: Update Organization Name
- info:
name: Update Organization plan
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organizations/:id/plan'
params:
- name: id
value: ''
type: path
docs: Update Organization plan
- info:
name: Reactivate an Organization
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organizations/:id/reactivate'
params:
- name: id
value: ''
type: path
docs: Reactivate an Organization
- info:
name: Upsert Organization's signup qualification
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organizations/:id/signup_qualification'
params:
- name: id
value: ''
type: path
docs: Upsert Organization's signup qualification
- info:
name: Switch Organization context
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organizations/:id/switch'
headers:
- name: seon-fp
value: ''
params:
- name: id
value: ''
type: path
docs: Switch Organization context
- info:
name: Get Budget
type: http
http:
method: GET
url: '{{baseUrl}}/v1/organizations/:organization_id/budget'
params:
- name: organization_id
value: ''
type: path
docs: Get Budget
- info:
name: Create Budget
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organizations/:organization_id/budget'
params:
- name: organization_id
value: ''
type: path
docs: Create Budget
- info:
name: Update Budget
type: http
http:
method: PUT
url: '{{baseUrl}}/v1/organizations/:organization_id/budget'
params:
- name: organization_id
value: ''
type: path
docs: Update Budget
- info:
name: Delete Budget
type: http
http:
method: DELETE
url: '{{baseUrl}}/v1/organizations/:organization_id/budget'
params:
- name: organization_id
value: ''
type: path
docs: Delete Budget
- info:
name: Unscope Organization Token
type: http
http:
method: POST
url: '{{baseUrl}}/v1/unscope_organization_token'
headers:
- name: seon-fp
value: ''
docs: 'UnscopeOrganizationToken removes the organization scope from a token. This
endpoint is useful when a user wants to remove an organization: by
unscoping the token first, the user can then delete the organization
without invalidating his token.'
- info:
name: sso
type: folder
items:
- info:
name: CannyAuth
type: http
http:
method: POST
url: '{{baseUrl}}/v1/sso/canny'
- info:
name: DiscourseAuth
type: http
http:
method: POST
url: '{{baseUrl}}/v1/sso/discourse'
- info:
name: Summary
type: folder
items:
- info:
name: Get organization usage summary
type: http
http:
method: GET
url: '{{baseUrl}}/v1/organizations/:organization_id/summary'
params:
- name: organization_id
value: ''
type: path
description: Organization ID
docs: Get organization usage summary
- info:
name: Credentials
type: folder
items:
- info:
name: List credentials
type: http
http:
method: GET
url: '{{baseUrl}}/v1/credentials'
params:
- name: type
value: ''
type: query
description: (Optional) A filter for type
- name: name
value: ''
type: query
description: (Optional) A filter for name
- name: organization_id
value: ''
type: query
description: (Optional) Filter for an organization
- name: user_id
value: ''
type: query
description: (Optional) Filter for an user
- name: limit
value: ''
type: query
description: (Optional) The number of items to return
- name: offset
value: ''
type: query
description: (Optional) The offset in the list of item to return
docs: List credentials
- info:
name: Create credential
type: http
http:
method: POST
url: '{{baseUrl}}/v1/credentials'
docs: Create credential
- info:
name: Get credential
type: http
http:
method: GET
url: '{{baseUrl}}/v1/credentials/:id'
params:
- name: id
value: ''
type: path
docs: Get credential
- info:
name: Update credential
type: http
http:
method: PUT
url: '{{baseUrl}}/v1/credentials/:id'
params:
- name: id
value: ''
type: path
- name: update_mask
value: ''
type: query
docs: Update credential
- info:
name: Update credential
type: http
http:
method: PATCH
url: '{{baseUrl}}/v1/credentials/:id'
params:
- name: id
value: ''
type: path
- name: update_mask
value: ''
type: query
docs: Update credential
- info:
name: Delete credential
type: http
http:
method: DELETE
url: '{{baseUrl}}/v1/credentials/:id'
params:
- name: id
value: ''
type: path
docs: Delete credential
- info:
name: Sessions
type: folder
items:
- info:
name: Login user
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/login'
headers:
- name: seon-fp
value: ''
docs: Login user
- info:
name: Logout user
type: http
http:
method: DELETE
url: '{{baseUrl}}/v1/account/logout'
docs: Logout user
- info:
name: Refresh token
type: http
http:
method: PUT
url: '{{baseUrl}}/v1/account/refresh'
docs: Refresh token
- info:
name: New session
type: http
http:
method: POST
url: '{{baseUrl}}/v1/account/session'
docs: 'Creates a new session without an organization for current user.
NOTE: If you want a session linked to another organization, please use "Switch organization".'
- info:
name: OrganizationConfirmations
type: folder
items:
- info:
name: Confirm organization action
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organization_confirmations/:id'
params:
- name: id
value: ''
type: path
docs: Confirm organization action
- info:
name: Intercom
type: folder
items:
- info:
name: Get intercom profile
type: http
http:
method: GET
url: '{{baseUrl}}/v1/intercom/profile'
docs: Get intercom profile
- info:
name: Coupons
type: folder
items:
- info:
name: Redeem Coupon
type: http
http:
method: POST
url: '{{baseUrl}}/v1/coupons'
docs: This API allows to redeem a coupon. Pass the code you received in the body.
- info:
name: Projects
type: folder
items:
- info:
name: List projects
type: http
http:
method: GET
url: '{{baseUrl}}/v1/projects'
params:
- name: limit
value: ''
type: query
description: (Optional) The number of items to return
- name: offset
value: ''
type: query
description: (Optional) The offset in the list of item to return
docs: List projects
- info:
name: Create project
type: http
http:
method: POST
url: '{{baseUrl}}/v1/projects'
docs: Create project
- info:
name: Get project
type: http
http:
method: GET
url: '{{baseUrl}}/v1/projects/:id'
params:
- name: id
value: ''
type: path
docs: Get project
- info:
name: Update project
type: http
http:
method: PUT
url: '{{baseUrl}}/v1/projects/:id'
params:
- name: id
value: ''
type: path
- name: update_mask
value: ''
type: query
docs: Update project
- info:
name: Update project
type: http
http:
method: PATCH
url: '{{baseUrl}}/v1/projects/:id'
params:
- name: id
value: ''
type: path
- name: update_mask
value: ''
type: query
docs: Update project
- info:
name: Delete project
type: http
http:
method: DELETE
url: '{{baseUrl}}/v1/projects/:id'
params:
- name: id
value: ''
type: path
docs: Delete project
- info:
name: OrganizationMembers
type: folder
items:
- info:
name: List organization members
type: http
http:
method: GET
url: '{{baseUrl}}/v1/organization_members'
params:
- name: limit
value: ''
type: query
description: (Optional) The number of items to return
- name: offset
value: ''
type: query
description: (Optional) The offset in the list of item to return
- name: organization_id
value: ''
type: query
description: (Optional) Filter for an organization
- name: user_id
value: ''
type: query
description: (Optional) Filter for an user
- name: organization_statuses
value: ''
type: query
description: (Optional) Filter for organization statuses
docs: List organization members
- info:
name: Remove an organization member
type: http
http:
method: DELETE
url: '{{baseUrl}}/v1/organization_members/:id'
params:
- name: id
value: ''
type: path
docs: Remove an organization member
- info:
name: PaymentMethods
type: folder
items:
- info:
name: List payment methods
type: http
http:
method: GET
url: '{{baseUrl}}/v1/payment_methods'
params:
- name: limit
value: ''
type: query
description: (Optional) The number of items to return
- name: offset
value: ''
type: query
description: (Optional) The offset in the list of item to return
- name: statuses
value: ''
type: query
description: (Optional) Filter on payment method statuses
docs: List payment methods
- info:
name: Create payment authorization
type: http
http:
method: POST
url: '{{baseUrl}}/v1/payment_methods'
docs: Create payment authorization
- info:
name: Get payment method
type: http
http:
method: GET
url: '{{baseUrl}}/v1/payment_methods/:id'
params:
- name: id
value: ''
type: path
docs: Get payment method
- info:
name: Delete payment method
type: http
http:
method: DELETE
url: '{{baseUrl}}/v1/payment_methods/:id'
params:
- name: id
value: ''
type: path
docs: Delete payment method
- info:
name: Confirm payment authorization
type: http
http:
method: POST
url: '{{baseUrl}}/v1/payment_methods/:id/confirm'
params:
- name: id
value: ''
type: path
docs: Confirm payment authorization
- info:
name: OrganizationQuotas
type: folder
items:
- info:
name: GetQuotas
type: http
http:
method: GET
url: '{{baseUrl}}/v1/organizations/:organization_id/quotas'
params:
- name: organization_id
value: ''
type: path
- info:
name: OrganizationInvitations
type: folder
items:
- info:
name: List Organization Invitations
type: http
http:
method: GET
url: '{{baseUrl}}/v1/organization_invitations'
params:
- name: limit
value: ''
type: query
description: (Optional) The number of items to return
- name: offset
value: ''
type: query
description: (Optional) The offset in the list of item to return
- name: statuses
value: ''
type: query
description: (Optional) Filter on organization invitation statuses
- name: user_id
value: ''
type: query
description: '(Optional) Filter on invitee ID. Will match both invitations sent to
that user_id and invitations sent to the email of that user_id.
The only valid value is the requester''s user_id'
docs: List Organization Invitations
- info:
name: Create Organization Invitation
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organization_invitations'
docs: Create Organization Invitation
- info:
name: Get Organization Invitation
type: http
http:
method: GET
url: '{{baseUrl}}/v1/organization_invitations/:id'
params:
- name: id
value: ''
type: path
description: The id of the invitation to get
docs: Get Organization Invitation
- info:
name: Delete Organization Invitation
type: http
http:
method: DELETE
url: '{{baseUrl}}/v1/organization_invitations/:id'
params:
- name: id
value: ''
type: path
description: The id of the organization invitation to delete
docs: Delete Organization Invitation
- info:
name: Resend Organization Invitation
type: http
http:
method: POST
url: '{{baseUrl}}/v1/organization_invitations/:id/resend'
params:
- name: id
value: ''
type: path
description: The id of the organization invitation to resend
docs: Resend Organization Invitation
- info:
name: Subscriptions
type: folder
items:
- info:
name: Get Subscription
type: http
http:
method: GET
url: '{{baseUrl}}/v1/subscriptions/:id'
params:
- name: id
value: ''
type: path
description: The id of the instance
docs: Get Subscription
- info:
name: Logs
type: folder
items:
- info:
name: Query logs
type: http
http:
method: GET
url: '{{baseUrl}}/v1/streams/logs/query'
params:
- name: type
value: ''
type: query
description: Type of logs to retrieve, either "build" or "runtime". Defaults to "runtime".
- name: app_id
value: ''
type: query
description: (Optional) Filter on the provided app_id. At least one of app_id, service_id, deployment_id, regional_deployment_id
or instance_ids must be set.
- name: service_id
value: ''
type: query
description: (Optional) Filter on the provided service_id. At least one of app_id, service_id, deployment_id, regional_deployment_id
or instance_ids must be set.
- name: deployment_id
value: ''
type: query
description: (Optional) Filter on the provided deployment_id. At least one of app_id, service_id, deployment_id, regional_deployment_id
or instance_ids must be set.
- name: regional_deployment_id
value: ''
type: query
description: (Optional) Filter on the provided regional_deployment_id. At least one of app_id, service_id, deployment_id,
regional_deployment_id or instance_ids must be set.
- name: instance_id
value: ''
type: query
description: Deprecated, prefer using instance_ids instead.
- name: instance_ids
value: ''
type: query
description: (Optional) Filter on the provided instance_ids. At least one of app_id, service_id, deployment_id, regional_deployment_id
or instance_ids must be set.
- name: stream
value: ''
type: query
description: Deprecated, prefer using streams instead.
- name: streams
value: ''
type: query
description: '(Optional) Filter on stream: either "stdout", "stderr" or "koyeb" (for system logs).'
- name: start
value: ''
type: query
description: (Optional) Must always be before `end`. Defaults to 15 minutes ago.
- name: end
value: ''
type: query
description: (Optional) Must always be after `start`. Defaults to now.
- name: order
value: ''
type: query
description: (Optional) `asc` or `desc`. Defaults to `desc`.
- name: limit
value: ''
type: query
description: (Optional) Defaults to 100. Maximum of 1000.
- name: regex
value: ''
type: query
description: (Optional) Apply a regex to filter logs. Can't be used with `text`.
- name: text
value: ''
type: query
description: (Optional) Looks for this string in logs. Can't be used with `regex`.
- name: regions
value: ''
type: query
description: (Optional) Filter on the provided regions (e.g. ["fra", "was"]).
docs: Query logs
- info:
name: Tails logs
type: http
http:
method: GET
url: '{{baseUrl}}/v1/streams/logs/tail'
params:
- name: type
value: ''
type: query
description: Type of logs to retrieve, either "build" or "runtime". Defaults to "runtime".
- name: app_id
value: ''
type: query
description: (Optional) Filter on the provided app_id. At least one of app_id, service_id, deployment_id, regional_deployment_id
or instance_ids must be set.
- name: service_id
value: ''
type: query
description: (Optional) Filter on the provided service_id. At least one of app_id, service_id, deployment_id, regional_deployment_id
or instance_ids must be set.
- name: deployment_id
value: ''
type: query
description: (Optional) Filter on the provided deployment_id. At least one of app_id, service_id, deployment_id, regional_deployment_id
or instance_ids must be set.
- name: regional_deployment_id
value: ''
type: query
description: (Optional) Filter on the provided regional_deployment_id. At least one of app_id, service_id, depl
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/koyeb/refs/heads/main/apis.yml