Get deployment details

Get information about a deployment’s status.

GET /deployments/{id}

JavaScript

JavaScript

import Kernel from '@onkernel/sdk';

const client = new Kernel({
  apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});

const deployment = await client.deployments.retrieve('id');

console.log(deployment.id);

import os
from kernel import Kernel

client = Kernel(
    api_key=os.environ.get("KERNEL_API_KEY"),  # This is the default and can be omitted
)
deployment = client.deployments.retrieve(
    "id",
)
print(deployment.id)

package main

import (
	"context"
	"fmt"

	"github.com/kernel/kernel-go-sdk"
	"github.com/kernel/kernel-go-sdk/option"
)

func main() {
	client := kernel.NewClient(
		option.WithAPIKey("My API Key"),
	)
	deployment, err := client.Deployments.Get(context.TODO(), "id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", deployment.ID)
}

curl --request GET \
  --url https://api.onkernel.com/deployments/{id} \
  --header 'Authorization: Bearer <token>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onkernel.com/deployments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://api.onkernel.com/deployments/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/deployments/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "id": "rr33xuugxj9h0bkf1rdt2bet",
  "status": "queued",
  "region": "aws.us-east-1a",
  "created_at": "2023-11-07T05:31:56Z",
  "status_reason": "Deployment in progress",
  "entrypoint_rel_path": "src/app.py",
  "env_vars": {},
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Deployment ID

Response

200

application/json

Deployment retrieved successfully

Deployment record information.

id · string · required

Unique identifier for the deployment

Example:

"rr33xuugxj9h0bkf1rdt2bet"

status · enum<string> · required

Current status of the deployment

Available options: queued, in_progress, running, failed, stopped

Example:

"queued"

region · string · required

Deployment region code

Allowed value: "aws.us-east-1a"

Example:

"aws.us-east-1a"

created_at · string<date-time> · required

Timestamp when the deployment was created

status_reason · string

Status reason

Example:

"Deployment in progress"

entrypoint_rel_path · string

Relative path to the application entrypoint

Example:

"src/app.py"

env_vars · object

Environment variables configured for this deployment

Show child attributes

updated_at · string<date-time> | null

Timestamp when the deployment was last updated