Appearance
Fresh 🌱
List deployments ​
List deployments. Optionally filter by application name and version.
OpenAPI ​
yaml
openapi: 3.1.0
info:
title: Kernel API
description: Developer tools and cloud infrastructure for AI agents to use web browsers
version: 0.1.0
servers:
- url: https://api.onkernel.com
description: API Server
security:
- bearerAuth: []
tags:
- name: Browsers
description: Create and manage browser sessions.
- name: Browser Replays
description: Record and manage browser session video replays.
- name: Profiles
description: Create, list, retrieve, and delete browser profiles.
- name: Browser Filesystem
description: Read, write, and manage files on the browser instance.
- name: Browser Computer Controls
description: Control mouse, keyboard, and screen on the browser instance.
- name: Browser Playwright
description: Execute Playwright code against the browser instance.
- name: Browser Processes
description: Execute and manage processes on the browser instance.
- name: Browser Logs
description: Stream logs from the browser instance.
- name: Extensions
description: Create, list, retrieve, and delete browser extensions.
- name: Proxies
description: Create and manage proxy configurations for routing browser traffic.
- name: Browser Pools
description: Create and manage browser pools for acquiring and releasing browsers.
- name: Managed Auth
description: >-
Create and manage auth connections for automated credential capture and
login.
- name: Credentials
description: Create and manage credentials for authentication.
- name: Credential Providers
description: Configure external credential providers like 1Password.
- name: Apps
description: List applications and versions.
- name: Deployments
description: Create and manage app deployments and stream deployment events.
- name: Invocations
description: Invoke actions and stream or query invocation status and events.
- name: Projects
description: Create and manage projects for resource isolation within an organization.
paths:
/deployments:
get:
tags:
- Deployments
summary: List deployments
description: List deployments. Optionally filter by application name and version.
operationId: getDeployments
parameters:
- name: app_name
in: query
required: false
description: Filter results by application name.
schema:
type: string
- name: app_version
in: query
required: false
description: Filter results by application version. Requires app_name to be set.
schema:
type: string
- name: limit
in: query
required: false
description: Limit the number of deployments to return.
schema:
type: integer
minimum: 1
maximum: 100
default: 20
- name: offset
in: query
required: false
description: Offset the number of deployments to return.
schema:
type: integer
minimum: 0
default: 0
responses:
'200':
description: List of deployments.
headers:
X-Limit:
description: Limit the number of deployments to return.
schema:
type: integer
minimum: 1
maximum: 100
default: 20
X-Offset:
description: The offset of deployments to return.
schema:
type: integer
minimum: 0
default: 0
X-Next-Offset:
description: Next offset to use for pagination.
schema:
type: integer
nullable: true
X-Has-More:
description: Whether there are more deployments to fetch.
schema:
type: boolean
default: false
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Deployment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
security:
- bearerAuth: []
x-codeSamples:
- lang: JavaScript
source: >-
import Kernel from '@onkernel/sdk';
const client = new Kernel({
apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const deploymentListResponse of
client.deployments.list()) {
console.log(deploymentListResponse.id);
}
- lang: Python
source: |-
import os
from kernel import Kernel
client = Kernel(
api_key=os.environ.get("KERNEL_API_KEY"), # This is the default and can be omitted
)
page = client.deployments.list()
page = page.items[0]
print(page.id)
- lang: Go
source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/kernel/kernel-go-sdk\"\n\t\"github.com/kernel/kernel-go-sdk/option\"\n)\n\nfunc main() {\n\tclient := kernel.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Deployments.List(context.TODO(), kernel.DeploymentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n"
components:
schemas:
Deployment:
type: object
description: Deployment record information.
properties:
id:
type: string
description: Unique identifier for the deployment
example: rr33xuugxj9h0bkf1rdt2bet
status:
type: string
description: Current status of the deployment
enum:
- queued
- in_progress
- running
- failed
- stopped
example: queued
status_reason:
type: string
description: Status reason
example: Deployment in progress
region:
type: string
description: Deployment region code
example: aws.us-east-1a
const: aws.us-east-1a
entrypoint_rel_path:
type: string
description: Relative path to the application entrypoint
example: src/app.py
env_vars:
type: object
description: Environment variables configured for this deployment
additionalProperties:
type: string
created_at:
type: string
format: date-time
description: Timestamp when the deployment was created
updated_at:
type: string
format: date-time
nullable: true
description: Timestamp when the deployment was last updated
required:
- id
- status
- region
- created_at
Error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Application-specific error code (machine-readable)
example: bad_request
message:
type: string
description: Human-readable error description for debugging
example: 'Missing required field: app_name'
details:
type: array
description: Additional error details (for multiple errors)
items:
$ref: '#/components/schemas/ErrorDetail'
inner_error:
$ref: '#/components/schemas/ErrorDetail'
ErrorDetail:
type: object
properties:
code:
type: string
description: Lower-level error code providing more specific detail
example: invalid_input
message:
type: string
description: Further detail about the error
example: Provided version string is not semver compliant
responses:
BadRequest:
description: Bad Request - invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Unauthorized - missing or invalid authorization token
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
InternalError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer