Skip to content

Task

Explore REST API Documentation

As a developer, I access the REST API documentation, so that I can understand how to use the 'importImage' function for integrating functionalities in my applications.

Success definition: Given I am on the Cakework documentation page When I click on the 'Next REST' link and then the 'importImage' link Then I should see the details related to the 'importImage' function in the REST API documentation.

Trajectory

Step 1:

Url (before/after):

https://www.cakework.com/

https://docs.cakework.com/

Content (before/after): 

RootWebArea Cakework - Custom User Functions, focused, url='https://www.cakework.com/'
    banner
        navigation
            [27] link home, center=(430,44), inner_text=cakework, url='https://www.cakework.com/'
                image, url='https://cdn.prod.website-files.com/657b70a2deb5df1a6fb531ae/657bc0b944061f69591b8f21_cakework_logo.png'
Show more 
                heading cakework
            navigation
                [32] link Docs, center=(1564,44), url='https://docs.cakework.com/'
    main
        StaticText BETA
        heading Enable Custom User Code
        paragraph
            StaticText Equip your users to write custom functions for your product through Cakework's GUI and CLI, while you easily manage it all with our dashboard and SDK
        StaticText Join early access waitlist
        form Email Form 2
            [54] textbox, center=(608,642), contenteditable=True, required, type=email
            [55] button Submit, center=(957,642), contenteditable=True, type=submit
        image, url='https://assets-global.website-files.com/657b70a2deb5df1a6fb531ae/657fa0ae526b40c8ee0a332b_Group%2059%20(3)-p-500.png'
        heading Use Cases Enabled
        paragraph
            StaticText Enable custom user code without managing infrastructure, users, and providing a modern dev experience for your users and team alike
        image, url='https://assets-global.website-files.com/657b70a2deb5df1a6fb531ae/657f9ea0145e6b58c936dcb5_zap-p-500.png'
        heading Automate
        paragraph
            StaticText Your user can define simple or sophisticated triggers and automations (e.g., error handling)
        image, url='https://assets-global.website-files.com/657b70a2deb5df1a6fb531ae/657f9ec0787e20793db17791_toy-brick-p-500.png'
        heading Transform
        paragraph
            StaticText Support your users to integrate with any custom system or transform and enrich any data stream
        image, url='https://cdn.prod.website-files.com/657b70a2deb5df1a6fb531ae/6581d4537c1f80593db190c9_server.png'
        heading Deploy
        paragraph
            StaticText Provide your users a modern DX for them to build and run custom applications for your system
        heading Join early access waitlist
        form Email Form 2
            textbox Enter your email, required
            button Submit
    contentinfo
        link cakework, url='https://www.cakework.com/#'
            image, url='https://cdn.prod.website-files.com/657b70a2deb5df1a6fb531ae/657bc0b944061f69591b8f21_cakework_logo.png'
            heading cakework
        StaticText Sahale, Inc. DBA Cakework, 2023
        StaticText Info
        link Docs, url='https://docs.cakework.com/'
        StaticText Follow us
        link Discord, url='https://discord.gg/yB6GvheDcP'
        link X / Twitter, url='https://twitter.com/usecakework'

RootWebArea Getting Started | cakework, focused, url='https://docs.cakework.com/'
    region Skip to main content
        link Skip to main content, url='https://docs.cakework.com/#docusaurus_skipToContent_fallback'
    navigation
        [57] link Logo cakework docs!, center=(106,30), inner_text=cakework docs!, url='https://www.cakework.com/'
Show more 
            image Logo, url='https://docs.cakework.com/img/cakework_logo.png'
        [63] button Switch between dark and light mode (currently light mode), center=(1876,30), title=Switch between dark and light mode (currently light mode), type=button
            image
    complementary
        navigation
            list
                listitem
                    [76] link Getting Started, center=(149,84), url='https://docs.cakework.com/'
                listitem
                    [79] link Reference, center=(149,120), expanded=True, url='https://docs.cakework.com/#'
                    list
                        listitem
                            [82] link REST, center=(155,156), url='https://docs.cakework.com/reference/rest'
                        listitem
                            [84] link Typescript, center=(155,192), url='https://docs.cakework.com/reference/typescript'
    main
        article
            navigation Breadcrumbs
                list
                    listitem
                        [94] link Home page, center=(485,92), url='https://docs.cakework.com/'
                            image
                    [96] listitem, center=(588,92), inner_text=Getting Started
                        StaticText Getting Started
            heading Getting Started
            paragraph
                StaticText Hi friend! Cakework is a set of simple APIs for building serverless directly into your developer product. You describe how you want to package and run your users' code, and use Cakework to build images from Github, CLI, or even a browser. You use our APIs to run that code securely, and show logs and metrics back to your users.
            paragraph
                StaticText Reach out to us on
                [103] link Discord, center=(651,317), url='https://discord.gg/yB6GvheDcP'
                StaticText or
                [104] link email, center=(730,317), url='mailto:eric@cakework.com'
                StaticText to get access and get started!
        navigation Docs pages navigation
            [106] link Next REST », center=(1188,416), inner_text=Next
REST, url='https://docs.cakework.com/reference/rest'
    contentinfo
        [113] link GitHub, center=(868,989), url='https://github.com/usecakework'
        StaticText ·
        [116] link Discord, center=(966,989), url='https://discord.gg/yB6GvheDcP'
        StaticText ·
        [119] link Email, center=(1057,989), url='mailto:hi@cakework.com'
        StaticText Copyright © 2023 Sahale, Inc.

Reasoning for action: By clicking the 'Docs' link, I am taken from the main Cakework webpage to the designated documentation area. This is a critical initial step toward accessing the REST API documentation that includes the 'importImage' function. Getting to this page is necessary to find further links to the specific REST API section needed for my task.

Action: click(32) # Click on the Docs link in the navigation to explore the documentation.

Change Description: After clicking on the Docs link, the browser navigated to the documentation page with the title 'Getting Started | cakework', displaying various sections including a breadcrumb navigation, introductory content about Cakework, and links to further documentation. The main content area was updated to include paragraphs about Cakework's APIs and additional navigation links for exploring different documentation sections.

Screenshot before:Screenshot after:---

Step 2:

Url (before/after):

https://docs.cakework.com/

https://docs.cakework.com/reference/rest

Content (before/after): 

RootWebArea Getting Started | cakework, focused, url='https://docs.cakework.com/'
    region Skip to main content
        link Skip to main content, url='https://docs.cakework.com/#docusaurus_skipToContent_fallback'
    navigation
        [57] link Logo cakework docs!, center=(106,30), inner_text=cakework docs!, url='https://www.cakework.com/'
Show more 
            image Logo, url='https://docs.cakework.com/img/cakework_logo.png'
        [63] button Switch between dark and light mode (currently light mode), center=(1876,30), title=Switch between dark and light mode (currently light mode), type=button
            image
    complementary
        navigation
            list
                listitem
                    [76] link Getting Started, center=(149,84), url='https://docs.cakework.com/'
                listitem
                    [79] link Reference, center=(149,120), expanded=True, url='https://docs.cakework.com/#'
                    list
                        listitem
                            [82] link REST, center=(155,156), url='https://docs.cakework.com/reference/rest'
                        listitem
                            [84] link Typescript, center=(155,192), url='https://docs.cakework.com/reference/typescript'
    main
        article
            navigation Breadcrumbs
                list
                    listitem
                        [94] link Home page, center=(485,92), url='https://docs.cakework.com/'
                            image
                    [96] listitem, center=(588,92), inner_text=Getting Started
                        StaticText Getting Started
            heading Getting Started
            paragraph
                StaticText Hi friend! Cakework is a set of simple APIs for building serverless directly into your developer product. You describe how you want to package and run your users' code, and use Cakework to build images from Github, CLI, or even a browser. You use our APIs to run that code securely, and show logs and metrics back to your users.
            paragraph
                StaticText Reach out to us on
                [103] link Discord, center=(651,317), url='https://discord.gg/yB6GvheDcP'
                StaticText or
                [104] link email, center=(730,317), url='mailto:eric@cakework.com'
                StaticText to get access and get started!
        navigation Docs pages navigation
            [106] link Next REST », center=(1188,416), inner_text=Next
REST, url='https://docs.cakework.com/reference/rest'
    contentinfo
        [113] link GitHub, center=(868,989), url='https://github.com/usecakework'
        StaticText ·
        [116] link Discord, center=(966,989), url='https://discord.gg/yB6GvheDcP'
        StaticText ·
        [119] link Email, center=(1057,989), url='mailto:hi@cakework.com'
        StaticText Copyright © 2023 Sahale, Inc.

RootWebArea REST | cakework, focused, url='https://docs.cakework.com/reference/rest'
    region Skip to main content
        link Skip to main content, url='https://docs.cakework.com/reference/rest#docusaurus_skipToContent_fallback'
    navigation
        [57] link Logo cakework docs!, center=(106,30), inner_text=cakework docs!, url='https://www.cakework.com/'
Show more 
            image Logo, url='https://docs.cakework.com/img/cakework_logo.png'
        [63] button Switch between dark and light mode (currently light mode), center=(1876,30), title=Switch between dark and light mode (currently light mode), type=button
            image
    complementary
        navigation
            list
                listitem
                    [76] link Getting Started, center=(146,84), url='https://docs.cakework.com/'
                listitem
                    [79] link Reference, center=(146,120), expanded=True, url='https://docs.cakework.com/reference/rest#'
                    list
                        listitem
                            [82] link REST, center=(152,156), url='https://docs.cakework.com/reference/rest'
                        listitem
                            [84] link Typescript, center=(152,192), url='https://docs.cakework.com/reference/typescript'
    main
        article
            navigation Breadcrumbs
                list
                    listitem
                        [148] link Home page, center=(485,92), url='https://docs.cakework.com/'
                            image
                    [150] listitem, center=(583,92), inner_text=Reference
                        StaticText Reference
                    [153] listitem, center=(664,92), inner_text=REST
                        StaticText REST
            heading REST
            paragraph
                StaticText The endpoint is
                code
                    StaticText https://api.cakework.com/v1
                StaticText . To authorize requests, add your API key to the header with
                code
                    StaticText X-Api-Key
                StaticText as the key. Parameters are passed as JSON in the request body.
            heading Images#​
                [164] link #​, center=(614,318), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#images'
            paragraph
                StaticText Use these APIs to get images into Cakework. You start VMs with Cakework images.
            heading importImage#​
                [167] link #​, center=(654,429), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#importimage'
            paragraph
                StaticText Import a Cakework image from an existing AWS ECR Docker repository.
            heading Endpoint#​
                [170] link #​, center=(557,525), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#endpoint'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/import
            [180] button Copy code to clipboard, center=(1400,625), title=Copy, type=button
            heading Request#​
                [185] link #​, center=(551,684), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#request'
            code
                StaticText {
                StaticText "imageUri"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "password"
                StaticText :
                StaticText "string"
                StaticText }
            [216] button Copy code to clipboard, center=(1400,739), title=Copy, type=button
            paragraph
                strong
                    code
                        StaticText imageUri
                StaticText URI of the container image to import.
                strong
                    code
                        StaticText password
                StaticText Password to the respository.
            heading Response#​
                [227] link #​, center=(564,924), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#response'
            code
                StaticText {
                StaticText "imageId"
                StaticText :
                StaticText "string"
                StaticText }
            [249] button Copy code to clipboard, center=(1400,979), title=Copy, type=button
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText The id used to reference this image.
            heading buildImageFromFiles#​
                link #​, url='https://docs.cakework.com/reference/rest#buildimagefromfiles'
            paragraph
                StaticText Build a Cakework image from a list of files. This API takes all of your file contents as strings. This immediately returns a
                code
                    StaticText buildId
                StaticText with which you can call
                code
                    StaticText getBuild
                StaticText to get the build status and the image ID. Reach out to us if you want onboard onto our webhooks to receive build succeeded events containing the built image id and build failed events.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-1'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/build/files
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-1'
            code
                StaticText {
                StaticText "dockerfile"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "files"
                StaticText :
                StaticText [
                StaticText {
                StaticText "dir"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "name"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "content"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ]
                StaticText ,
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText dockerfile
                StaticText A Dockerfile describing the image you want to build as a string.
                strong
                    code
                        StaticText files
                StaticText A list of objects that describe all of the code files.
                code
                    StaticText dir
                StaticText The directory to put the file in. Use
                code
                    StaticText .
                StaticText for root.
                code
                    StaticText name
                StaticText The name of the file to write, e.g. handlers.json".
                code
                    StaticText content
                StaticText The content of the file as a string.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-1'
            code
                StaticText {
                StaticText "buildId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "status"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText build
                StaticText The id used to reference the build.
                strong
                    code
                        StaticText status
                StaticText The status of the build.
                code
                    StaticText buildImageFromGithub
                StaticText will always return
                code
                    StaticText created
                StaticText as the status, as this API returns immediately before starting the background build job.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was created.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was last updated.
            heading buildImageFromGithub#​
                link #​, url='https://docs.cakework.com/reference/rest#buildimagefromgithub'
            paragraph
                StaticText Build a Cakework image from your user's Github repository. You supply a Dockerfile (so you can hide this from your user) and optionally a .dockerignore file. This immediately returns a
                code
                    StaticText buildId
                StaticText with which you can call
                code
                    StaticText getBuild
                StaticText to get the build status and the image ID. Reach out to us if you want onboard onto our webhooks to receive build succeeded events containing the built image id and build failed events.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-2'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/build/github
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-2'
            code
                StaticText {
                StaticText "dockerfile"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "dockerignore"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "token"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "repository"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "branch"
                StaticText :
                StaticText "string"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText dockerfile
                StaticText A Dockerfile describing the container you want to deploy as a string.
                strong
                    code
                        StaticText dockerignore
                StaticText (optional) The .dockerignore file as a string.
                strong
                    code
                        StaticText token
                StaticText User token that your Github App fetches to access the user's Github repository.
                strong
                    code
                        StaticText repository
                StaticText Github repository of your user's code, in the format ${my-org}/${my-repo}.
                strong
                    code
                        StaticText branch
                StaticText Branch of user's Github repository, e.g.
                code
                    StaticText main
                StaticText .
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-2'
            code
                StaticText {
                StaticText "buildId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "status"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText build
                StaticText The id used to reference the build.
                strong
                    code
                        StaticText status
                StaticText The status of the build. Will always be
                code
                    StaticText created
                StaticText initialy, since
                code
                    StaticText buildImageFromGithub
                StaticText returns immediately before actually starting the background build job.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was created.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was last updated.
            heading getBuild#​
                link #​, url='https://docs.cakework.com/reference/rest#getbuild'
            paragraph
                StaticText Get information about a build.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-3'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/build/[buildId]
            button Copy code to clipboard
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-3'
            code
                StaticText {
                StaticText "buildId"
                StaticText :
                StaticText "af3e93bb-5c9e-42d6-9c80-e841344f9a52"
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "32GT08QBZ30M6R0CM27PSZC34G"
                StaticText ,
                StaticText "status"
                StaticText :
                StaticText "succeeded"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText buildId
                StaticText The build ID.
                strong
                    code
                        StaticText imageId
                StaticText (optional) The id used to reference this image. If the build has not yet succeeded, this will be absent.
                strong
                    code
                        StaticText status
                StaticText (optional) Status of the build. Can be
                code
                    StaticText created
                StaticText ,
                code
                    StaticText succeeded
                StaticText , or
                code
                    StaticText failed
                StaticText .
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was created.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was last updated.
            heading getBuildLogs#​
                link #​, url='https://docs.cakework.com/reference/rest#getbuildlogs'
            paragraph
                StaticText Get logs for a build.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-4'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/image/build/[buildId]/logs
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters'
            paragraph
                strong
                    code
                        StaticText query
                StaticText (optional) String to look for in the logs. Case-insensitive. If this parameter is not provided, all logs for the build are returned.
                strong
                    code
                        StaticText batch
                StaticText (optional) The number of rows to return. Accepts a range of 50-1000. Default: 100 rows.
                strong
                    code
                        StaticText order
                StaticText (optional) The order by timestamp to return the logs. Options are
                code
                    StaticText newest_first
                StaticText and
                code
                    StaticText oldest_first
                StaticText . Defaults to
                code
                    StaticText oldest_first
                StaticText .
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token returned by the previous call to get logs. Will be used to fetch the next batch of logs.
                strong
                    code
                        StaticText from
                StaticText (optional) Start of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000). If the call to
                code
                    StaticText getBuildLogs
                StaticText returns
                code
                    StaticText pagination
                StaticText ,
                code
                    StaticText from
                StaticText , and
                code
                    StaticText to
                StaticText fields, you must pass all 3 query parameters in the next call to
                code
                    StaticText getBuildLogs
                StaticText to fetch the next batch of logs.
                strong
                    code
                        StaticText to
                StaticText (optional) End of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000).
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-4'
            code
                StaticText {
                StaticText "lines"
                StaticText :
                StaticText [
                StaticText {
                StaticText "timestamp"
                StaticText :
                StaticText 1676625938460
                StaticText ,
                StaticText "level"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "message"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "XlG9SZP"
                StaticText ,
                StaticText "from"
                StaticText :
                StaticText "2023-03-07 06:12:56 UTC"
                StaticText ,
                StaticText "to"
                StaticText :
                StaticText "2023-03-08 06:11:56 UTC"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText lines
                StaticText All the lines returned in the log.
                code
                    StaticText timestamp
                StaticText The unix timestamp in ms.
                code
                    StaticText level
                StaticText The log level (e.g. info/error).
                code
                    StaticText message
                StaticText The message.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText from
                StaticText (optional) If present, the next from timestamp with which you can query for more logs.
                strong
                    code
                        StaticText to
                StaticText (optional) If present, the next to timestamp with which you can query for more logs.
            heading VMs#​
                link #​, url='https://docs.cakework.com/reference/rest#vms'
            paragraph
                StaticText Use these APIs for one-time use VMs. These have a cold start of several seconds depending on the size of your image. Each VM runs in its own VPC.
            heading startVM#​
                link #​, url='https://docs.cakework.com/reference/rest#startvm'
            paragraph
                StaticText Start a virtual machine using an image.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-5'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/start
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-3'
            code
                StaticText {
                StaticText "imageId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "port"
                StaticText :
                StaticText 8080
                StaticText ,
                StaticText "envVars"
                StaticText :
                StaticText {
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 3
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText The id of the image to start the VM with.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs for the VM. Can be a number between 1 and 8.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory for the VM. Can be a number between 256 and 16384.
                strong
                    code
                        StaticText port
                StaticText (optional) The internal port to open.
                strong
                    code
                        StaticText envVars
                StaticText (optional) The environment variables as a map of string to string.
                strong
                    code
                        StaticText volumeGB
                StaticText (optional) The amount of persistent storage to attach to each VM, in GB. Can be a number between 1 and 500.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-5'
            code
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "e784996f346483"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "01gv2zfbt345trtrdk6vhbeccz.fly.dev"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "01GTZHKS9CZHQ1NKZCA3LG0H4D"
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "started"
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText id
                StaticText The id used to reference this VM.
                strong
                    code
                        StaticText hostname
                StaticText The hostname used to access this VM.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory allocated for this VM, in MB.
                strong
                    code
                        StaticText imageId
                StaticText The image ID of the Docker image this VM is running.
                strong
                    code
                        StaticText state
                StaticText The current state of the VM. Can be created, started, stopped, or destroyed.
                strong
                    code
                        StaticText createdAt
                StaticText The date and time this VM was created.
                strong
                    code
                        StaticText updatedAt
                StaticText The date and time this VM was last updated.
                strong
                    code
                        StaticText port
                StaticText (optional) The port (if any) allocated for this VM.
                strong
                    code
                        StaticText volumeGB
                StaticText (optional) The amount of disk storage, in GB, to attach to the VM.
            heading stopVM#​
                link #​, url='https://docs.cakework.com/reference/rest#stopvm'
            paragraph
                StaticText Stop a running VM. This destroys the VM, as the start/stopVM commands are for one-time use VMs.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-6'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/[vmId]/stop
            button Copy code to clipboard
            heading getVMLogs#​
                link #​, url='https://docs.cakework.com/reference/rest#getvmlogs'
            paragraph
                StaticText Get all of the logs for a VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-7'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/vm/[vmId]/logs
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters-1'
            paragraph
                strong
                    code
                        StaticText query
                StaticText (optional) String to look for in the logs. Case-insensitive. If this parameter is not provided, all logs for the vm are returned.
                strong
                    code
                        StaticText batch
                StaticText (optional) The number of rows to return. Accepts a range of 50-1000. Default: 100 rows.
                strong
                    code
                        StaticText order
                StaticText (optional) The order by timestamp to return the logs. Options are
                code
                    StaticText newest_first
                StaticText and
                code
                    StaticText oldest_first
                StaticText . Defaults to
                code
                    StaticText oldest_first
                StaticText .
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token returned by the previous call to get logs. Will be used to fetch the next batch of logs.
                strong
                    code
                        StaticText from
                StaticText (optional) Start of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000). If the call to
                code
                    StaticText getBuildLogs
                StaticText returns
                code
                    StaticText pagination
                StaticText ,
                code
                    StaticText from
                StaticText , and
                code
                    StaticText to
                StaticText fields, you must pass all 3 query parameters in the next call to
                code
                    StaticText getBuildLogs
                StaticText to fetch the next batch of logs.
                strong
                    code
                        StaticText to
                StaticText (optional) End of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000).
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-6'
            code
                StaticText {
                StaticText "lines"
                StaticText :
                StaticText [
                StaticText {
                StaticText "timestamp"
                StaticText :
                StaticText 1676625938460
                StaticText ,
                StaticText "level"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "message"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "XlG9SZP"
                StaticText ,
                StaticText "from"
                StaticText :
                StaticText "2023-03-07 06:12:56 UTC"
                StaticText ,
                StaticText "to"
                StaticText :
                StaticText "2023-03-08 06:11:56 UTC"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText lines
                StaticText All the lines returned in the log.
                code
                    StaticText timestamp
                StaticText The unix timestamp in ms.
                code
                    StaticText level
                StaticText The log level (e.g. info/error).
                code
                    StaticText message
                StaticText The message.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText from
                StaticText (optional) If present, the next from timestamp with which you can query for more logs.
                strong
                    code
                        StaticText to
                StaticText (optional) If present, the next to timestamp with which you can query for more logs.
            heading getVm#​
                link #​, url='https://docs.cakework.com/reference/rest#getvm'
            paragraph
                StaticText Get information about a virtual machine.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-8'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/vm/[vmId]
            button Copy code to clipboard
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-7'
            code
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "32GT08QBZ30M6R0CM27PSZC34G"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "port"
                StaticText :
                StaticText 8080
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "started"
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 1
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText id
                StaticText The id used to reference this VM.
                strong
                    code
                        StaticText hostname
                StaticText The hostname used to access this VM.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory allocated for this VM, in MB
                strong
                    code
                        StaticText imageId
                StaticText The image ID of the Docker image this VM is running.
                strong
                    code
                        StaticText createdAt
                StaticText The date and time this VM was created.
                strong
                    code
                        StaticText updatedAt
                StaticText The date and time this VM was last updated.
                strong
                    code
                        StaticText port
                StaticText The port (if any) allocated for this VM.
                strong
                    code
                        StaticText state
                StaticText The current state of the VM. Can be
                code
                    StaticText created
                StaticText ,
                code
                    StaticText started
                StaticText ,
                code
                    StaticText stopped
                StaticText , and
                code
                    StaticText destroyed
                StaticText .
                strong
                    code
                        StaticText volumeGB
                StaticText (optional). The disk size of the attached volume, in GB. If not provided, defaults to 0.
            heading listVMs#​
                link #​, url='https://docs.cakework.com/reference/rest#listvms'
            paragraph
                StaticText List the virtual machines which belong to you. You can filter the query.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-9'
            StaticText GET
            code
                StaticText https://api.cakework.com/vms
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters-2'
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText (optional) Filter VMs by which have a particular image ID deployed.
                strong
                    code
                        StaticText status
                StaticText (optional) Filter VMs by a particular status. Options are created, started, stopped, or destroyed.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-8'
            code
                StaticText {
                StaticText "vms"
                StaticText :
                StaticText [
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "148e446b7e7089"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "01gtmj7swt42zpq48dqb4bgy8x.fly.dev"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "01GTK500PATD76RYGWGBTSK9KY"
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "stopped"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-03-03T20:22:39.096Z"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-03-03T22:01:56.092Z"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "string"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText vms
                StaticText All the lines returned in the log.
                code
                    StaticText id
                StaticText The ID of the VM.
                code
                    StaticText state
                StaticText The status of the VM.
                code
                    StaticText imageId
                StaticText The image ID of the VM.
                code
                    StaticText hostname
                StaticText The hostname used to access this VM.
                code
                    StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                code
                    StaticText memory
                StaticText The amount of memory allocated for this VM, in MB.
                code
                    StaticText state
                StaticText The current state of the VM.
                code
                    StaticText createdAt
                StaticText The date and time this VM was created.
                code
                    StaticText updatedAt
                StaticText The date and time this VM was last updated.
                code
                    StaticText port
                StaticText (optional) The port (if any) allocated for this VM.
                code
                    StaticText volumeGB
                StaticText (optional) The amount of disk storage, in GB, to attach to the VM.
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token with which you can fetch the next page.
            heading Cached VMs#​
                link #​, url='https://docs.cakework.com/reference/rest#cached-vms'
            paragraph
                StaticText Use these APIs for re-usable VMs. This helps you get much faster cold starts.
            heading cacheVM#​
                link #​, url='https://docs.cakework.com/reference/rest#cachevm'
            paragraph
                StaticText Cache a VM using an image. You still need to call
                code
                    StaticText startCachedVM
                StaticText to start a cached VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-10'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cache
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-4'
            code
                StaticText {
                StaticText "imageId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "port"
                StaticText :
                StaticText 8080
                StaticText ,
                StaticText "envVars"
                StaticText :
                StaticText {
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText "diskSize"
                StaticText :
                StaticText 3
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText The id of the image to cache the VM with.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs for the VM. Can be a number between 1 and 8.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory for the VM. Can be a number between 256 and 16384.
                strong
                    code
                        StaticText port
                StaticText (optional) The internal port to open.
                strong
                    code
                        StaticText envVars
                StaticText (optional) The evironment variables as a map of string to string.
                strong
                    code
                        StaticText diskSize
                StaticText (optional) The amount of persistent storage to attach to each VM, in GB. Can be a number between 1 and 500.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-9'
            code
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "e784996f346483"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "01gv2zfbt345trtrdk6vhbeccz.fly.dev"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "01GTZHKS9CZHQ1NKZCA3LG0H4D"
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "stopped"
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText id
                StaticText The id used to reference this VM.
                strong
                    code
                        StaticText hostname
                StaticText The hostname used to access this VM.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory allocated for this VM, in MB.
                strong
                    code
                        StaticText imageId
                StaticText The image ID of the Docker image this VM is running.
                strong
                    code
                        StaticText state
                StaticText The current state of the VM. Will be
                code
                    StaticText stopped
                StaticText after the call to cache the VM.
                strong
                    code
                        StaticText createdAt
                StaticText The date and time this VM was created.
                strong
                    code
                        StaticText updatedAt
                StaticText The date and time this VM was last updated.
                strong
                    code
                        StaticText port
                StaticText (optional) The port (if any) allocated for this VM.
                strong
                    code
                        StaticText volumeGB
                StaticText (optional) The amount of disk storage, in GB, to attach to the VM.
            heading startCachedVM#​
                link #​, url='https://docs.cakework.com/reference/rest#startcachedvm'
            paragraph
                StaticText Start a cached VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-11'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cached/[cachedVmId]/start
            button Copy code to clipboard
            heading stopCachedVM#​
                link #​, url='https://docs.cakework.com/reference/rest#stopcachedvm'
            paragraph
                StaticText Stop a cached VM. You can stop the cached VM by exiting the process as well.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-12'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cached/[cachedVmId]/stop
            button Copy code to clipboard
            heading destroyCachedVM#​
                link #​, url='https://docs.cakework.com/reference/rest#destroycachedvm'
            paragraph
                StaticText Destroy a cached VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-13'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cached/[cachedVmId]/destroy
            button Copy code to clipboard
            heading Function#​
                link #​, url='https://docs.cakework.com/reference/rest#function'
            paragraph
                StaticText Use these APIs to deploy a function.
            heading getBuildLogs#​
                link #​, url='https://docs.cakework.com/reference/rest#getbuildlogs-1'
            paragraph
                StaticText Get logs for a build.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-14'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/function/build/[buildId]/logs
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters-3'
            paragraph
                strong
                    code
                        StaticText query
                StaticText (optional) String to look for in the logs. Case-insensitive. If this parameter is not provided, all logs for the build are returned.
                strong
                    code
                        StaticText batch
                StaticText (optional) The number of rows to return. Accepts a range of 50-1000. Default: 100 rows.
                strong
                    code
                        StaticText order
                StaticText (optional) The order by timestamp to return the logs. Options are
                code
                    StaticText newest_first
                StaticText and
                code
                    StaticText oldest_first
                StaticText . Defaults to
                code
                    StaticText oldest_first
                StaticText .
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token returned by the previous call to get logs. Will be used to fetch the next batch of logs.
                strong
                    code
                        StaticText from
                StaticText (optional) Start of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000). If the call to
                code
                    StaticText getBuildLogs
                StaticText returns
                code
                    StaticText pagination
                StaticText ,
                code
                    StaticText from
                StaticText , and
                code
                    StaticText to
                StaticText fields, you must pass all 3 query parameters in the next call to
                code
                    StaticText getBuildLogs
                StaticText to fetch the next batch of logs.
                strong
                    code
                        StaticText to
                StaticText (optional) End of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000).
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-10'
            code
                StaticText {
                StaticText "lines"
                StaticText :
                StaticText [
                StaticText {
                StaticText "timestamp"
                StaticText :
                StaticText 1676625938460
                StaticText ,
                StaticText "level"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "message"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "XlG9SZP"
                StaticText ,
                StaticText "from"
                StaticText :
                StaticText "2023-03-07 06:12:56 UTC"
                StaticText ,
                StaticText "to"
                StaticText :
                StaticText "2023-03-08 06:11:56 UTC"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText lines
                StaticText All the lines returned in the log.
                code
                    StaticText timestamp
                StaticText The unix timestamp in ms.
                code
                    StaticText level
                StaticText The log level (e.g. info/error).
                code
                    StaticText message
                StaticText The message.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText from
                StaticText (optional) If present, the next from timestamp with which you can query for more logs.
                strong
                    code
                        StaticText to
                StaticText (optional) If present, the next to timestamp with which you can query for more logs.
        navigation Docs pages navigation
            link Previous « Getting Started, url='https://docs.cakework.com/'
            link Next Typescript », url='https://docs.cakework.com/reference/typescript'
        list
            listitem
                [2115] link Images, center=(1610,103), url='https://docs.cakework.com/reference/rest#images'
                list
                    listitem
                        [2118] link importImage, center=(1614,132), url='https://docs.cakework.com/reference/rest#importimage'
                    listitem
                        [2120] link buildImageFromFiles, center=(1614,161), url='https://docs.cakework.com/reference/rest#buildimagefromfiles'
                    listitem
                        [2122] link buildImageFromGithub, center=(1614,190), url='https://docs.cakework.com/reference/rest#buildimagefromgithub'
                    listitem
                        [2124] link getBuild, center=(1614,219), url='https://docs.cakework.com/reference/rest#getbuild'
                    listitem
                        [2126] link getBuildLogs, center=(1614,248), url='https://docs.cakework.com/reference/rest#getbuildlogs'
            listitem
                [2128] link VMs, center=(1610,277), url='https://docs.cakework.com/reference/rest#vms'
                list
                    listitem
                        [2131] link startVM, center=(1614,306), url='https://docs.cakework.com/reference/rest#startvm'
                    listitem
                        [2133] link stopVM, center=(1614,335), url='https://docs.cakework.com/reference/rest#stopvm'
                    listitem
                        [2135] link getVMLogs, center=(1614,365), url='https://docs.cakework.com/reference/rest#getvmlogs'
                    listitem
                        [2137] link getVm, center=(1614,394), url='https://docs.cakework.com/reference/rest#getvm'
                    listitem
                        [2139] link listVMs, center=(1614,423), url='https://docs.cakework.com/reference/rest#listvms'
            listitem
                [2141] link Cached VMs, center=(1610,452), url='https://docs.cakework.com/reference/rest#cached-vms'
                list
                    listitem
                        [2144] link cacheVM, center=(1614,481), url='https://docs.cakework.com/reference/rest#cachevm'
                    listitem
                        [2146] link startCachedVM, center=(1614,510), url='https://docs.cakework.com/reference/rest#startcachedvm'
                    listitem
                        [2148] link stopCachedVM, center=(1614,539), url='https://docs.cakework.com/reference/rest#stopcachedvm'
                    listitem
                        [2150] link destroyCachedVM, center=(1614,568), url='https://docs.cakework.com/reference/rest#destroycachedvm'
            listitem
                [2152] link Function, center=(1610,597), url='https://docs.cakework.com/reference/rest#function'
                list
                    listitem
                        [2155] link getBuildLogs, center=(1614,627), url='https://docs.cakework.com/reference/rest#getbuildlogs-1'
    contentinfo
        link GitHub, url='https://github.com/usecakework'
        StaticText ·
        link Discord, url='https://discord.gg/yB6GvheDcP'
        StaticText ·
        link Email, url='mailto:hi@cakework.com'
        StaticText Copyright © 2023 Sahale, Inc.

Reasoning for action: By clicking on the 'Next REST' link, I am directing the browser to load the REST API documentation page. This is a necessary step toward achieving the user story, as the imported image function details are likely to be located there. The next page is expected to have more specific links or sections that include the 'importImage' function, which is crucial for the user’s objective.

Action: click(106) # Click on the 'Next REST' link to explore the REST documentation.

Change Description: After the action of clicking the 'Next REST' link, the browser's page changed from 'Getting Started' to 'REST'. The URL updated to 'https://docs.cakework.com/reference/rest', and the displayed content now includes sections relevant to the REST API documentation.

Screenshot before:Screenshot after:---

Step 3:

Url (before/after):

https://docs.cakework.com/reference/rest

https://docs.cakework.com/reference/rest#importimage

Content (before/after): 

RootWebArea REST | cakework, focused, url='https://docs.cakework.com/reference/rest'
    region Skip to main content
        link Skip to main content, url='https://docs.cakework.com/reference/rest#docusaurus_skipToContent_fallback'
    navigation
        [57] link Logo cakework docs!, center=(106,30), inner_text=cakework docs!, url='https://www.cakework.com/'
Show more 
            image Logo, url='https://docs.cakework.com/img/cakework_logo.png'
        [63] button Switch between dark and light mode (currently light mode), center=(1876,30), title=Switch between dark and light mode (currently light mode), type=button
            image
    complementary
        navigation
            list
                listitem
                    [76] link Getting Started, center=(146,84), url='https://docs.cakework.com/'
                listitem
                    [79] link Reference, center=(146,120), expanded=True, url='https://docs.cakework.com/reference/rest#'
                    list
                        listitem
                            [82] link REST, center=(152,156), url='https://docs.cakework.com/reference/rest'
                        listitem
                            [84] link Typescript, center=(152,192), url='https://docs.cakework.com/reference/typescript'
    main
        article
            navigation Breadcrumbs
                list
                    listitem
                        [148] link Home page, center=(485,92), url='https://docs.cakework.com/'
                            image
                    [150] listitem, center=(583,92), inner_text=Reference
                        StaticText Reference
                    [153] listitem, center=(664,92), inner_text=REST
                        StaticText REST
            heading REST
            paragraph
                StaticText The endpoint is
                code
                    StaticText https://api.cakework.com/v1
                StaticText . To authorize requests, add your API key to the header with
                code
                    StaticText X-Api-Key
                StaticText as the key. Parameters are passed as JSON in the request body.
            heading Images#​
                [164] link #​, center=(614,318), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#images'
            paragraph
                StaticText Use these APIs to get images into Cakework. You start VMs with Cakework images.
            heading importImage#​
                [167] link #​, center=(654,429), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#importimage'
            paragraph
                StaticText Import a Cakework image from an existing AWS ECR Docker repository.
            heading Endpoint#​
                [170] link #​, center=(557,525), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#endpoint'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/import
            [180] button Copy code to clipboard, center=(1400,625), title=Copy, type=button
            heading Request#​
                [185] link #​, center=(551,684), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#request'
            code
                StaticText {
                StaticText "imageUri"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "password"
                StaticText :
                StaticText "string"
                StaticText }
            [216] button Copy code to clipboard, center=(1400,739), title=Copy, type=button
            paragraph
                strong
                    code
                        StaticText imageUri
                StaticText URI of the container image to import.
                strong
                    code
                        StaticText password
                StaticText Password to the respository.
            heading Response#​
                [227] link #​, center=(564,924), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#response'
            code
                StaticText {
                StaticText "imageId"
                StaticText :
                StaticText "string"
                StaticText }
            [249] button Copy code to clipboard, center=(1400,979), title=Copy, type=button
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText The id used to reference this image.
            heading buildImageFromFiles#​
                link #​, url='https://docs.cakework.com/reference/rest#buildimagefromfiles'
            paragraph
                StaticText Build a Cakework image from a list of files. This API takes all of your file contents as strings. This immediately returns a
                code
                    StaticText buildId
                StaticText with which you can call
                code
                    StaticText getBuild
                StaticText to get the build status and the image ID. Reach out to us if you want onboard onto our webhooks to receive build succeeded events containing the built image id and build failed events.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-1'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/build/files
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-1'
            code
                StaticText {
                StaticText "dockerfile"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "files"
                StaticText :
                StaticText [
                StaticText {
                StaticText "dir"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "name"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "content"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ]
                StaticText ,
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText dockerfile
                StaticText A Dockerfile describing the image you want to build as a string.
                strong
                    code
                        StaticText files
                StaticText A list of objects that describe all of the code files.
                code
                    StaticText dir
                StaticText The directory to put the file in. Use
                code
                    StaticText .
                StaticText for root.
                code
                    StaticText name
                StaticText The name of the file to write, e.g. handlers.json".
                code
                    StaticText content
                StaticText The content of the file as a string.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-1'
            code
                StaticText {
                StaticText "buildId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "status"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText build
                StaticText The id used to reference the build.
                strong
                    code
                        StaticText status
                StaticText The status of the build.
                code
                    StaticText buildImageFromGithub
                StaticText will always return
                code
                    StaticText created
                StaticText as the status, as this API returns immediately before starting the background build job.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was created.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was last updated.
            heading buildImageFromGithub#​
                link #​, url='https://docs.cakework.com/reference/rest#buildimagefromgithub'
            paragraph
                StaticText Build a Cakework image from your user's Github repository. You supply a Dockerfile (so you can hide this from your user) and optionally a .dockerignore file. This immediately returns a
                code
                    StaticText buildId
                StaticText with which you can call
                code
                    StaticText getBuild
                StaticText to get the build status and the image ID. Reach out to us if you want onboard onto our webhooks to receive build succeeded events containing the built image id and build failed events.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-2'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/build/github
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-2'
            code
                StaticText {
                StaticText "dockerfile"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "dockerignore"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "token"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "repository"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "branch"
                StaticText :
                StaticText "string"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText dockerfile
                StaticText A Dockerfile describing the container you want to deploy as a string.
                strong
                    code
                        StaticText dockerignore
                StaticText (optional) The .dockerignore file as a string.
                strong
                    code
                        StaticText token
                StaticText User token that your Github App fetches to access the user's Github repository.
                strong
                    code
                        StaticText repository
                StaticText Github repository of your user's code, in the format ${my-org}/${my-repo}.
                strong
                    code
                        StaticText branch
                StaticText Branch of user's Github repository, e.g.
                code
                    StaticText main
                StaticText .
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-2'
            code
                StaticText {
                StaticText "buildId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "status"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText build
                StaticText The id used to reference the build.
                strong
                    code
                        StaticText status
                StaticText The status of the build. Will always be
                code
                    StaticText created
                StaticText initialy, since
                code
                    StaticText buildImageFromGithub
                StaticText returns immediately before actually starting the background build job.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was created.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was last updated.
            heading getBuild#​
                link #​, url='https://docs.cakework.com/reference/rest#getbuild'
            paragraph
                StaticText Get information about a build.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-3'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/build/[buildId]
            button Copy code to clipboard
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-3'
            code
                StaticText {
                StaticText "buildId"
                StaticText :
                StaticText "af3e93bb-5c9e-42d6-9c80-e841344f9a52"
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "32GT08QBZ30M6R0CM27PSZC34G"
                StaticText ,
                StaticText "status"
                StaticText :
                StaticText "succeeded"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText buildId
                StaticText The build ID.
                strong
                    code
                        StaticText imageId
                StaticText (optional) The id used to reference this image. If the build has not yet succeeded, this will be absent.
                strong
                    code
                        StaticText status
                StaticText (optional) Status of the build. Can be
                code
                    StaticText created
                StaticText ,
                code
                    StaticText succeeded
                StaticText , or
                code
                    StaticText failed
                StaticText .
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was created.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was last updated.
            heading getBuildLogs#​
                link #​, url='https://docs.cakework.com/reference/rest#getbuildlogs'
            paragraph
                StaticText Get logs for a build.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-4'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/image/build/[buildId]/logs
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters'
            paragraph
                strong
                    code
                        StaticText query
                StaticText (optional) String to look for in the logs. Case-insensitive. If this parameter is not provided, all logs for the build are returned.
                strong
                    code
                        StaticText batch
                StaticText (optional) The number of rows to return. Accepts a range of 50-1000. Default: 100 rows.
                strong
                    code
                        StaticText order
                StaticText (optional) The order by timestamp to return the logs. Options are
                code
                    StaticText newest_first
                StaticText and
                code
                    StaticText oldest_first
                StaticText . Defaults to
                code
                    StaticText oldest_first
                StaticText .
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token returned by the previous call to get logs. Will be used to fetch the next batch of logs.
                strong
                    code
                        StaticText from
                StaticText (optional) Start of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000). If the call to
                code
                    StaticText getBuildLogs
                StaticText returns
                code
                    StaticText pagination
                StaticText ,
                code
                    StaticText from
                StaticText , and
                code
                    StaticText to
                StaticText fields, you must pass all 3 query parameters in the next call to
                code
                    StaticText getBuildLogs
                StaticText to fetch the next batch of logs.
                strong
                    code
                        StaticText to
                StaticText (optional) End of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000).
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-4'
            code
                StaticText {
                StaticText "lines"
                StaticText :
                StaticText [
                StaticText {
                StaticText "timestamp"
                StaticText :
                StaticText 1676625938460
                StaticText ,
                StaticText "level"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "message"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "XlG9SZP"
                StaticText ,
                StaticText "from"
                StaticText :
                StaticText "2023-03-07 06:12:56 UTC"
                StaticText ,
                StaticText "to"
                StaticText :
                StaticText "2023-03-08 06:11:56 UTC"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText lines
                StaticText All the lines returned in the log.
                code
                    StaticText timestamp
                StaticText The unix timestamp in ms.
                code
                    StaticText level
                StaticText The log level (e.g. info/error).
                code
                    StaticText message
                StaticText The message.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText from
                StaticText (optional) If present, the next from timestamp with which you can query for more logs.
                strong
                    code
                        StaticText to
                StaticText (optional) If present, the next to timestamp with which you can query for more logs.
            heading VMs#​
                link #​, url='https://docs.cakework.com/reference/rest#vms'
            paragraph
                StaticText Use these APIs for one-time use VMs. These have a cold start of several seconds depending on the size of your image. Each VM runs in its own VPC.
            heading startVM#​
                link #​, url='https://docs.cakework.com/reference/rest#startvm'
            paragraph
                StaticText Start a virtual machine using an image.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-5'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/start
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-3'
            code
                StaticText {
                StaticText "imageId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "port"
                StaticText :
                StaticText 8080
                StaticText ,
                StaticText "envVars"
                StaticText :
                StaticText {
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 3
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText The id of the image to start the VM with.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs for the VM. Can be a number between 1 and 8.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory for the VM. Can be a number between 256 and 16384.
                strong
                    code
                        StaticText port
                StaticText (optional) The internal port to open.
                strong
                    code
                        StaticText envVars
                StaticText (optional) The environment variables as a map of string to string.
                strong
                    code
                        StaticText volumeGB
                StaticText (optional) The amount of persistent storage to attach to each VM, in GB. Can be a number between 1 and 500.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-5'
            code
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "e784996f346483"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "01gv2zfbt345trtrdk6vhbeccz.fly.dev"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "01GTZHKS9CZHQ1NKZCA3LG0H4D"
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "started"
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText id
                StaticText The id used to reference this VM.
                strong
                    code
                        StaticText hostname
                StaticText The hostname used to access this VM.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory allocated for this VM, in MB.
                strong
                    code
                        StaticText imageId
                StaticText The image ID of the Docker image this VM is running.
                strong
                    code
                        StaticText state
                StaticText The current state of the VM. Can be created, started, stopped, or destroyed.
                strong
                    code
                        StaticText createdAt
                StaticText The date and time this VM was created.
                strong
                    code
                        StaticText updatedAt
                StaticText The date and time this VM was last updated.
                strong
                    code
                        StaticText port
                StaticText (optional) The port (if any) allocated for this VM.
                strong
                    code
                        StaticText volumeGB
                StaticText (optional) The amount of disk storage, in GB, to attach to the VM.
            heading stopVM#​
                link #​, url='https://docs.cakework.com/reference/rest#stopvm'
            paragraph
                StaticText Stop a running VM. This destroys the VM, as the start/stopVM commands are for one-time use VMs.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-6'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/[vmId]/stop
            button Copy code to clipboard
            heading getVMLogs#​
                link #​, url='https://docs.cakework.com/reference/rest#getvmlogs'
            paragraph
                StaticText Get all of the logs for a VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-7'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/vm/[vmId]/logs
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters-1'
            paragraph
                strong
                    code
                        StaticText query
                StaticText (optional) String to look for in the logs. Case-insensitive. If this parameter is not provided, all logs for the vm are returned.
                strong
                    code
                        StaticText batch
                StaticText (optional) The number of rows to return. Accepts a range of 50-1000. Default: 100 rows.
                strong
                    code
                        StaticText order
                StaticText (optional) The order by timestamp to return the logs. Options are
                code
                    StaticText newest_first
                StaticText and
                code
                    StaticText oldest_first
                StaticText . Defaults to
                code
                    StaticText oldest_first
                StaticText .
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token returned by the previous call to get logs. Will be used to fetch the next batch of logs.
                strong
                    code
                        StaticText from
                StaticText (optional) Start of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000). If the call to
                code
                    StaticText getBuildLogs
                StaticText returns
                code
                    StaticText pagination
                StaticText ,
                code
                    StaticText from
                StaticText , and
                code
                    StaticText to
                StaticText fields, you must pass all 3 query parameters in the next call to
                code
                    StaticText getBuildLogs
                StaticText to fetch the next batch of logs.
                strong
                    code
                        StaticText to
                StaticText (optional) End of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000).
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-6'
            code
                StaticText {
                StaticText "lines"
                StaticText :
                StaticText [
                StaticText {
                StaticText "timestamp"
                StaticText :
                StaticText 1676625938460
                StaticText ,
                StaticText "level"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "message"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "XlG9SZP"
                StaticText ,
                StaticText "from"
                StaticText :
                StaticText "2023-03-07 06:12:56 UTC"
                StaticText ,
                StaticText "to"
                StaticText :
                StaticText "2023-03-08 06:11:56 UTC"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText lines
                StaticText All the lines returned in the log.
                code
                    StaticText timestamp
                StaticText The unix timestamp in ms.
                code
                    StaticText level
                StaticText The log level (e.g. info/error).
                code
                    StaticText message
                StaticText The message.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText from
                StaticText (optional) If present, the next from timestamp with which you can query for more logs.
                strong
                    code
                        StaticText to
                StaticText (optional) If present, the next to timestamp with which you can query for more logs.
            heading getVm#​
                link #​, url='https://docs.cakework.com/reference/rest#getvm'
            paragraph
                StaticText Get information about a virtual machine.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-8'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/vm/[vmId]
            button Copy code to clipboard
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-7'
            code
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "32GT08QBZ30M6R0CM27PSZC34G"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "port"
                StaticText :
                StaticText 8080
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "started"
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 1
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText id
                StaticText The id used to reference this VM.
                strong
                    code
                        StaticText hostname
                StaticText The hostname used to access this VM.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory allocated for this VM, in MB
                strong
                    code
                        StaticText imageId
                StaticText The image ID of the Docker image this VM is running.
                strong
                    code
                        StaticText createdAt
                StaticText The date and time this VM was created.
                strong
                    code
                        StaticText updatedAt
                StaticText The date and time this VM was last updated.
                strong
                    code
                        StaticText port
                StaticText The port (if any) allocated for this VM.
                strong
                    code
                        StaticText state
                StaticText The current state of the VM. Can be
                code
                    StaticText created
                StaticText ,
                code
                    StaticText started
                StaticText ,
                code
                    StaticText stopped
                StaticText , and
                code
                    StaticText destroyed
                StaticText .
                strong
                    code
                        StaticText volumeGB
                StaticText (optional). The disk size of the attached volume, in GB. If not provided, defaults to 0.
            heading listVMs#​
                link #​, url='https://docs.cakework.com/reference/rest#listvms'
            paragraph
                StaticText List the virtual machines which belong to you. You can filter the query.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-9'
            StaticText GET
            code
                StaticText https://api.cakework.com/vms
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters-2'
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText (optional) Filter VMs by which have a particular image ID deployed.
                strong
                    code
                        StaticText status
                StaticText (optional) Filter VMs by a particular status. Options are created, started, stopped, or destroyed.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-8'
            code
                StaticText {
                StaticText "vms"
                StaticText :
                StaticText [
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "148e446b7e7089"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "01gtmj7swt42zpq48dqb4bgy8x.fly.dev"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "01GTK500PATD76RYGWGBTSK9KY"
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "stopped"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-03-03T20:22:39.096Z"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-03-03T22:01:56.092Z"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "string"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText vms
                StaticText All the lines returned in the log.
                code
                    StaticText id
                StaticText The ID of the VM.
                code
                    StaticText state
                StaticText The status of the VM.
                code
                    StaticText imageId
                StaticText The image ID of the VM.
                code
                    StaticText hostname
                StaticText The hostname used to access this VM.
                code
                    StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                code
                    StaticText memory
                StaticText The amount of memory allocated for this VM, in MB.
                code
                    StaticText state
                StaticText The current state of the VM.
                code
                    StaticText createdAt
                StaticText The date and time this VM was created.
                code
                    StaticText updatedAt
                StaticText The date and time this VM was last updated.
                code
                    StaticText port
                StaticText (optional) The port (if any) allocated for this VM.
                code
                    StaticText volumeGB
                StaticText (optional) The amount of disk storage, in GB, to attach to the VM.
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token with which you can fetch the next page.
            heading Cached VMs#​
                link #​, url='https://docs.cakework.com/reference/rest#cached-vms'
            paragraph
                StaticText Use these APIs for re-usable VMs. This helps you get much faster cold starts.
            heading cacheVM#​
                link #​, url='https://docs.cakework.com/reference/rest#cachevm'
            paragraph
                StaticText Cache a VM using an image. You still need to call
                code
                    StaticText startCachedVM
                StaticText to start a cached VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-10'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cache
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-4'
            code
                StaticText {
                StaticText "imageId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "port"
                StaticText :
                StaticText 8080
                StaticText ,
                StaticText "envVars"
                StaticText :
                StaticText {
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText "diskSize"
                StaticText :
                StaticText 3
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText The id of the image to cache the VM with.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs for the VM. Can be a number between 1 and 8.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory for the VM. Can be a number between 256 and 16384.
                strong
                    code
                        StaticText port
                StaticText (optional) The internal port to open.
                strong
                    code
                        StaticText envVars
                StaticText (optional) The evironment variables as a map of string to string.
                strong
                    code
                        StaticText diskSize
                StaticText (optional) The amount of persistent storage to attach to each VM, in GB. Can be a number between 1 and 500.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-9'
            code
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "e784996f346483"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "01gv2zfbt345trtrdk6vhbeccz.fly.dev"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "01GTZHKS9CZHQ1NKZCA3LG0H4D"
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "stopped"
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText id
                StaticText The id used to reference this VM.
                strong
                    code
                        StaticText hostname
                StaticText The hostname used to access this VM.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory allocated for this VM, in MB.
                strong
                    code
                        StaticText imageId
                StaticText The image ID of the Docker image this VM is running.
                strong
                    code
                        StaticText state
                StaticText The current state of the VM. Will be
                code
                    StaticText stopped
                StaticText after the call to cache the VM.
                strong
                    code
                        StaticText createdAt
                StaticText The date and time this VM was created.
                strong
                    code
                        StaticText updatedAt
                StaticText The date and time this VM was last updated.
                strong
                    code
                        StaticText port
                StaticText (optional) The port (if any) allocated for this VM.
                strong
                    code
                        StaticText volumeGB
                StaticText (optional) The amount of disk storage, in GB, to attach to the VM.
            heading startCachedVM#​
                link #​, url='https://docs.cakework.com/reference/rest#startcachedvm'
            paragraph
                StaticText Start a cached VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-11'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cached/[cachedVmId]/start
            button Copy code to clipboard
            heading stopCachedVM#​
                link #​, url='https://docs.cakework.com/reference/rest#stopcachedvm'
            paragraph
                StaticText Stop a cached VM. You can stop the cached VM by exiting the process as well.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-12'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cached/[cachedVmId]/stop
            button Copy code to clipboard
            heading destroyCachedVM#​
                link #​, url='https://docs.cakework.com/reference/rest#destroycachedvm'
            paragraph
                StaticText Destroy a cached VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-13'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cached/[cachedVmId]/destroy
            button Copy code to clipboard
            heading Function#​
                link #​, url='https://docs.cakework.com/reference/rest#function'
            paragraph
                StaticText Use these APIs to deploy a function.
            heading getBuildLogs#​
                link #​, url='https://docs.cakework.com/reference/rest#getbuildlogs-1'
            paragraph
                StaticText Get logs for a build.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-14'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/function/build/[buildId]/logs
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters-3'
            paragraph
                strong
                    code
                        StaticText query
                StaticText (optional) String to look for in the logs. Case-insensitive. If this parameter is not provided, all logs for the build are returned.
                strong
                    code
                        StaticText batch
                StaticText (optional) The number of rows to return. Accepts a range of 50-1000. Default: 100 rows.
                strong
                    code
                        StaticText order
                StaticText (optional) The order by timestamp to return the logs. Options are
                code
                    StaticText newest_first
                StaticText and
                code
                    StaticText oldest_first
                StaticText . Defaults to
                code
                    StaticText oldest_first
                StaticText .
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token returned by the previous call to get logs. Will be used to fetch the next batch of logs.
                strong
                    code
                        StaticText from
                StaticText (optional) Start of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000). If the call to
                code
                    StaticText getBuildLogs
                StaticText returns
                code
                    StaticText pagination
                StaticText ,
                code
                    StaticText from
                StaticText , and
                code
                    StaticText to
                StaticText fields, you must pass all 3 query parameters in the next call to
                code
                    StaticText getBuildLogs
                StaticText to fetch the next batch of logs.
                strong
                    code
                        StaticText to
                StaticText (optional) End of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000).
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-10'
            code
                StaticText {
                StaticText "lines"
                StaticText :
                StaticText [
                StaticText {
                StaticText "timestamp"
                StaticText :
                StaticText 1676625938460
                StaticText ,
                StaticText "level"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "message"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "XlG9SZP"
                StaticText ,
                StaticText "from"
                StaticText :
                StaticText "2023-03-07 06:12:56 UTC"
                StaticText ,
                StaticText "to"
                StaticText :
                StaticText "2023-03-08 06:11:56 UTC"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText lines
                StaticText All the lines returned in the log.
                code
                    StaticText timestamp
                StaticText The unix timestamp in ms.
                code
                    StaticText level
                StaticText The log level (e.g. info/error).
                code
                    StaticText message
                StaticText The message.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText from
                StaticText (optional) If present, the next from timestamp with which you can query for more logs.
                strong
                    code
                        StaticText to
                StaticText (optional) If present, the next to timestamp with which you can query for more logs.
        navigation Docs pages navigation
            link Previous « Getting Started, url='https://docs.cakework.com/'
            link Next Typescript », url='https://docs.cakework.com/reference/typescript'
        list
            listitem
                [2115] link Images, center=(1610,103), url='https://docs.cakework.com/reference/rest#images'
                list
                    listitem
                        [2118] link importImage, center=(1614,132), url='https://docs.cakework.com/reference/rest#importimage'
                    listitem
                        [2120] link buildImageFromFiles, center=(1614,161), url='https://docs.cakework.com/reference/rest#buildimagefromfiles'
                    listitem
                        [2122] link buildImageFromGithub, center=(1614,190), url='https://docs.cakework.com/reference/rest#buildimagefromgithub'
                    listitem
                        [2124] link getBuild, center=(1614,219), url='https://docs.cakework.com/reference/rest#getbuild'
                    listitem
                        [2126] link getBuildLogs, center=(1614,248), url='https://docs.cakework.com/reference/rest#getbuildlogs'
            listitem
                [2128] link VMs, center=(1610,277), url='https://docs.cakework.com/reference/rest#vms'
                list
                    listitem
                        [2131] link startVM, center=(1614,306), url='https://docs.cakework.com/reference/rest#startvm'
                    listitem
                        [2133] link stopVM, center=(1614,335), url='https://docs.cakework.com/reference/rest#stopvm'
                    listitem
                        [2135] link getVMLogs, center=(1614,365), url='https://docs.cakework.com/reference/rest#getvmlogs'
                    listitem
                        [2137] link getVm, center=(1614,394), url='https://docs.cakework.com/reference/rest#getvm'
                    listitem
                        [2139] link listVMs, center=(1614,423), url='https://docs.cakework.com/reference/rest#listvms'
            listitem
                [2141] link Cached VMs, center=(1610,452), url='https://docs.cakework.com/reference/rest#cached-vms'
                list
                    listitem
                        [2144] link cacheVM, center=(1614,481), url='https://docs.cakework.com/reference/rest#cachevm'
                    listitem
                        [2146] link startCachedVM, center=(1614,510), url='https://docs.cakework.com/reference/rest#startcachedvm'
                    listitem
                        [2148] link stopCachedVM, center=(1614,539), url='https://docs.cakework.com/reference/rest#stopcachedvm'
                    listitem
                        [2150] link destroyCachedVM, center=(1614,568), url='https://docs.cakework.com/reference/rest#destroycachedvm'
            listitem
                [2152] link Function, center=(1610,597), url='https://docs.cakework.com/reference/rest#function'
                list
                    listitem
                        [2155] link getBuildLogs, center=(1614,627), url='https://docs.cakework.com/reference/rest#getbuildlogs-1'
    contentinfo
        link GitHub, url='https://github.com/usecakework'
        StaticText ·
        link Discord, url='https://discord.gg/yB6GvheDcP'
        StaticText ·
        link Email, url='mailto:hi@cakework.com'
        StaticText Copyright © 2023 Sahale, Inc.

RootWebArea REST | cakework, focused, url='https://docs.cakework.com/reference/rest#importimage'
    region Skip to main content
        link Skip to main content, url='https://docs.cakework.com/reference/rest#docusaurus_skipToContent_fallback'
    navigation
        [57] link Logo cakework docs!, center=(106,376), inner_text=cakework docs!, url='https://www.cakework.com/'
Show more 
            image Logo, url='https://docs.cakework.com/img/cakework_logo.png'
        [63] button Switch between dark and light mode (currently light mode), center=(1876,376), title=Switch between dark and light mode (currently light mode), type=button
            image
    complementary
        navigation
            list
                listitem
                    [76] link Getting Started, center=(146,430), url='https://docs.cakework.com/'
                listitem
                    [79] link Reference, center=(146,466), expanded=True, url='https://docs.cakework.com/reference/rest#'
                    list
                        listitem
                            [82] link REST, center=(152,502), url='https://docs.cakework.com/reference/rest'
                        listitem
                            [84] link Typescript, center=(152,538), url='https://docs.cakework.com/reference/typescript'
    main
        article
            navigation Breadcrumbs
                list
                    listitem
                        link Home page, url='https://docs.cakework.com/'
                            image
                    listitem
                        StaticText Reference
                    listitem
                        StaticText REST
            heading REST
            paragraph
                StaticText The endpoint is
                code
                    StaticText https://api.cakework.com/v1
                StaticText . To authorize requests, add your API key to the header with
                code
                    StaticText X-Api-Key
                StaticText as the key. Parameters are passed as JSON in the request body.
            heading Images#​
                link #​, url='https://docs.cakework.com/reference/rest#images'
            paragraph
                StaticText Use these APIs to get images into Cakework. You start VMs with Cakework images.
            heading importImage#​
                [167] link #​, center=(654,429), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#importimage'
            paragraph
                StaticText Import a Cakework image from an existing AWS ECR Docker repository.
            heading Endpoint#​
                [170] link #​, center=(557,525), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#endpoint'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/import
            [180] button Copy code to clipboard, center=(1400,625), title=Copy, type=button
            heading Request#​
                [185] link #​, center=(551,684), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#request'
            code
                StaticText {
                StaticText "imageUri"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "password"
                StaticText :
                StaticText "string"
                StaticText }
            [216] button Copy code to clipboard, center=(1400,739), title=Copy, type=button
            paragraph
                strong
                    code
                        StaticText imageUri
                StaticText URI of the container image to import.
                strong
                    code
                        StaticText password
                StaticText Password to the respository.
            heading Response#​
                [227] link #​, center=(564,924), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#response'
            code
                StaticText {
                StaticText "imageId"
                StaticText :
                StaticText "string"
                StaticText }
            [249] button Copy code to clipboard, center=(1400,979), title=Copy, type=button
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText The id used to reference this image.
            heading buildImageFromFiles#​
                [257] link #​, center=(763,1130), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#buildimagefromfiles'
            paragraph
                StaticText Build a Cakework image from a list of files. This API takes all of your file contents as strings. This immediately returns a
                code
                    StaticText buildId
                StaticText with which you can call
                code
                    StaticText getBuild
                StaticText to get the build status and the image ID. Reach out to us if you want onboard onto our webhooks to receive build succeeded events containing the built image id and build failed events.
            heading Endpoint#​
                [262] link #​, center=(557,1278), inner_text=​, title=Direct link to heading, url='https://docs.cakework.com/reference/rest#endpoint-1'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/build/files
            [272] button Copy code to clipboard, center=(1400,1378), title=Copy, type=button
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-1'
            code
                StaticText {
                StaticText "dockerfile"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "files"
                StaticText :
                StaticText [
                StaticText {
                StaticText "dir"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "name"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "content"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ]
                StaticText ,
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText dockerfile
                StaticText A Dockerfile describing the image you want to build as a string.
                strong
                    code
                        StaticText files
                StaticText A list of objects that describe all of the code files.
                code
                    StaticText dir
                StaticText The directory to put the file in. Use
                code
                    StaticText .
                StaticText for root.
                code
                    StaticText name
                StaticText The name of the file to write, e.g. handlers.json".
                code
                    StaticText content
                StaticText The content of the file as a string.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-1'
            code
                StaticText {
                StaticText "buildId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "status"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText build
                StaticText The id used to reference the build.
                strong
                    code
                        StaticText status
                StaticText The status of the build.
                code
                    StaticText buildImageFromGithub
                StaticText will always return
                code
                    StaticText created
                StaticText as the status, as this API returns immediately before starting the background build job.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was created.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was last updated.
            heading buildImageFromGithub#​
                link #​, url='https://docs.cakework.com/reference/rest#buildimagefromgithub'
            paragraph
                StaticText Build a Cakework image from your user's Github repository. You supply a Dockerfile (so you can hide this from your user) and optionally a .dockerignore file. This immediately returns a
                code
                    StaticText buildId
                StaticText with which you can call
                code
                    StaticText getBuild
                StaticText to get the build status and the image ID. Reach out to us if you want onboard onto our webhooks to receive build succeeded events containing the built image id and build failed events.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-2'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/build/github
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-2'
            code
                StaticText {
                StaticText "dockerfile"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "dockerignore"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "token"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "repository"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "branch"
                StaticText :
                StaticText "string"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText dockerfile
                StaticText A Dockerfile describing the container you want to deploy as a string.
                strong
                    code
                        StaticText dockerignore
                StaticText (optional) The .dockerignore file as a string.
                strong
                    code
                        StaticText token
                StaticText User token that your Github App fetches to access the user's Github repository.
                strong
                    code
                        StaticText repository
                StaticText Github repository of your user's code, in the format ${my-org}/${my-repo}.
                strong
                    code
                        StaticText branch
                StaticText Branch of user's Github repository, e.g.
                code
                    StaticText main
                StaticText .
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-2'
            code
                StaticText {
                StaticText "buildId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "status"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText build
                StaticText The id used to reference the build.
                strong
                    code
                        StaticText status
                StaticText The status of the build. Will always be
                code
                    StaticText created
                StaticText initialy, since
                code
                    StaticText buildImageFromGithub
                StaticText returns immediately before actually starting the background build job.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was created.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was last updated.
            heading getBuild#​
                link #​, url='https://docs.cakework.com/reference/rest#getbuild'
            paragraph
                StaticText Get information about a build.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-3'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/image/build/[buildId]
            button Copy code to clipboard
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-3'
            code
                StaticText {
                StaticText "buildId"
                StaticText :
                StaticText "af3e93bb-5c9e-42d6-9c80-e841344f9a52"
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "32GT08QBZ30M6R0CM27PSZC34G"
                StaticText ,
                StaticText "status"
                StaticText :
                StaticText "succeeded"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText buildId
                StaticText The build ID.
                strong
                    code
                        StaticText imageId
                StaticText (optional) The id used to reference this image. If the build has not yet succeeded, this will be absent.
                strong
                    code
                        StaticText status
                StaticText (optional) Status of the build. Can be
                code
                    StaticText created
                StaticText ,
                code
                    StaticText succeeded
                StaticText , or
                code
                    StaticText failed
                StaticText .
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was created.
                strong
                    code
                        StaticText createdAt
                StaticText The time at which the build was last updated.
            heading getBuildLogs#​
                link #​, url='https://docs.cakework.com/reference/rest#getbuildlogs'
            paragraph
                StaticText Get logs for a build.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-4'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/image/build/[buildId]/logs
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters'
            paragraph
                strong
                    code
                        StaticText query
                StaticText (optional) String to look for in the logs. Case-insensitive. If this parameter is not provided, all logs for the build are returned.
                strong
                    code
                        StaticText batch
                StaticText (optional) The number of rows to return. Accepts a range of 50-1000. Default: 100 rows.
                strong
                    code
                        StaticText order
                StaticText (optional) The order by timestamp to return the logs. Options are
                code
                    StaticText newest_first
                StaticText and
                code
                    StaticText oldest_first
                StaticText . Defaults to
                code
                    StaticText oldest_first
                StaticText .
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token returned by the previous call to get logs. Will be used to fetch the next batch of logs.
                strong
                    code
                        StaticText from
                StaticText (optional) Start of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000). If the call to
                code
                    StaticText getBuildLogs
                StaticText returns
                code
                    StaticText pagination
                StaticText ,
                code
                    StaticText from
                StaticText , and
                code
                    StaticText to
                StaticText fields, you must pass all 3 query parameters in the next call to
                code
                    StaticText getBuildLogs
                StaticText to fetch the next batch of logs.
                strong
                    code
                        StaticText to
                StaticText (optional) End of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000).
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-4'
            code
                StaticText {
                StaticText "lines"
                StaticText :
                StaticText [
                StaticText {
                StaticText "timestamp"
                StaticText :
                StaticText 1676625938460
                StaticText ,
                StaticText "level"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "message"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "XlG9SZP"
                StaticText ,
                StaticText "from"
                StaticText :
                StaticText "2023-03-07 06:12:56 UTC"
                StaticText ,
                StaticText "to"
                StaticText :
                StaticText "2023-03-08 06:11:56 UTC"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText lines
                StaticText All the lines returned in the log.
                code
                    StaticText timestamp
                StaticText The unix timestamp in ms.
                code
                    StaticText level
                StaticText The log level (e.g. info/error).
                code
                    StaticText message
                StaticText The message.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText from
                StaticText (optional) If present, the next from timestamp with which you can query for more logs.
                strong
                    code
                        StaticText to
                StaticText (optional) If present, the next to timestamp with which you can query for more logs.
            heading VMs#​
                link #​, url='https://docs.cakework.com/reference/rest#vms'
            paragraph
                StaticText Use these APIs for one-time use VMs. These have a cold start of several seconds depending on the size of your image. Each VM runs in its own VPC.
            heading startVM#​
                link #​, url='https://docs.cakework.com/reference/rest#startvm'
            paragraph
                StaticText Start a virtual machine using an image.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-5'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/start
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-3'
            code
                StaticText {
                StaticText "imageId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "port"
                StaticText :
                StaticText 8080
                StaticText ,
                StaticText "envVars"
                StaticText :
                StaticText {
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 3
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText The id of the image to start the VM with.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs for the VM. Can be a number between 1 and 8.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory for the VM. Can be a number between 256 and 16384.
                strong
                    code
                        StaticText port
                StaticText (optional) The internal port to open.
                strong
                    code
                        StaticText envVars
                StaticText (optional) The environment variables as a map of string to string.
                strong
                    code
                        StaticText volumeGB
                StaticText (optional) The amount of persistent storage to attach to each VM, in GB. Can be a number between 1 and 500.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-5'
            code
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "e784996f346483"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "01gv2zfbt345trtrdk6vhbeccz.fly.dev"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "01GTZHKS9CZHQ1NKZCA3LG0H4D"
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "started"
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText id
                StaticText The id used to reference this VM.
                strong
                    code
                        StaticText hostname
                StaticText The hostname used to access this VM.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory allocated for this VM, in MB.
                strong
                    code
                        StaticText imageId
                StaticText The image ID of the Docker image this VM is running.
                strong
                    code
                        StaticText state
                StaticText The current state of the VM. Can be created, started, stopped, or destroyed.
                strong
                    code
                        StaticText createdAt
                StaticText The date and time this VM was created.
                strong
                    code
                        StaticText updatedAt
                StaticText The date and time this VM was last updated.
                strong
                    code
                        StaticText port
                StaticText (optional) The port (if any) allocated for this VM.
                strong
                    code
                        StaticText volumeGB
                StaticText (optional) The amount of disk storage, in GB, to attach to the VM.
            heading stopVM#​
                link #​, url='https://docs.cakework.com/reference/rest#stopvm'
            paragraph
                StaticText Stop a running VM. This destroys the VM, as the start/stopVM commands are for one-time use VMs.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-6'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/[vmId]/stop
            button Copy code to clipboard
            heading getVMLogs#​
                link #​, url='https://docs.cakework.com/reference/rest#getvmlogs'
            paragraph
                StaticText Get all of the logs for a VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-7'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/vm/[vmId]/logs
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters-1'
            paragraph
                strong
                    code
                        StaticText query
                StaticText (optional) String to look for in the logs. Case-insensitive. If this parameter is not provided, all logs for the vm are returned.
                strong
                    code
                        StaticText batch
                StaticText (optional) The number of rows to return. Accepts a range of 50-1000. Default: 100 rows.
                strong
                    code
                        StaticText order
                StaticText (optional) The order by timestamp to return the logs. Options are
                code
                    StaticText newest_first
                StaticText and
                code
                    StaticText oldest_first
                StaticText . Defaults to
                code
                    StaticText oldest_first
                StaticText .
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token returned by the previous call to get logs. Will be used to fetch the next batch of logs.
                strong
                    code
                        StaticText from
                StaticText (optional) Start of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000). If the call to
                code
                    StaticText getBuildLogs
                StaticText returns
                code
                    StaticText pagination
                StaticText ,
                code
                    StaticText from
                StaticText , and
                code
                    StaticText to
                StaticText fields, you must pass all 3 query parameters in the next call to
                code
                    StaticText getBuildLogs
                StaticText to fetch the next batch of logs.
                strong
                    code
                        StaticText to
                StaticText (optional) End of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000).
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-6'
            code
                StaticText {
                StaticText "lines"
                StaticText :
                StaticText [
                StaticText {
                StaticText "timestamp"
                StaticText :
                StaticText 1676625938460
                StaticText ,
                StaticText "level"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "message"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "XlG9SZP"
                StaticText ,
                StaticText "from"
                StaticText :
                StaticText "2023-03-07 06:12:56 UTC"
                StaticText ,
                StaticText "to"
                StaticText :
                StaticText "2023-03-08 06:11:56 UTC"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText lines
                StaticText All the lines returned in the log.
                code
                    StaticText timestamp
                StaticText The unix timestamp in ms.
                code
                    StaticText level
                StaticText The log level (e.g. info/error).
                code
                    StaticText message
                StaticText The message.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText from
                StaticText (optional) If present, the next from timestamp with which you can query for more logs.
                strong
                    code
                        StaticText to
                StaticText (optional) If present, the next to timestamp with which you can query for more logs.
            heading getVm#​
                link #​, url='https://docs.cakework.com/reference/rest#getvm'
            paragraph
                StaticText Get information about a virtual machine.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-8'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/vm/[vmId]
            button Copy code to clipboard
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-7'
            code
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "32GT08QBZ30M6R0CM27PSZC34G"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-02-24 20:29:40.331"
                StaticText ,
                StaticText "port"
                StaticText :
                StaticText 8080
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "started"
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 1
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText id
                StaticText The id used to reference this VM.
                strong
                    code
                        StaticText hostname
                StaticText The hostname used to access this VM.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory allocated for this VM, in MB
                strong
                    code
                        StaticText imageId
                StaticText The image ID of the Docker image this VM is running.
                strong
                    code
                        StaticText createdAt
                StaticText The date and time this VM was created.
                strong
                    code
                        StaticText updatedAt
                StaticText The date and time this VM was last updated.
                strong
                    code
                        StaticText port
                StaticText The port (if any) allocated for this VM.
                strong
                    code
                        StaticText state
                StaticText The current state of the VM. Can be
                code
                    StaticText created
                StaticText ,
                code
                    StaticText started
                StaticText ,
                code
                    StaticText stopped
                StaticText , and
                code
                    StaticText destroyed
                StaticText .
                strong
                    code
                        StaticText volumeGB
                StaticText (optional). The disk size of the attached volume, in GB. If not provided, defaults to 0.
            heading listVMs#​
                link #​, url='https://docs.cakework.com/reference/rest#listvms'
            paragraph
                StaticText List the virtual machines which belong to you. You can filter the query.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-9'
            StaticText GET
            code
                StaticText https://api.cakework.com/vms
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters-2'
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText (optional) Filter VMs by which have a particular image ID deployed.
                strong
                    code
                        StaticText status
                StaticText (optional) Filter VMs by a particular status. Options are created, started, stopped, or destroyed.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-8'
            code
                StaticText {
                StaticText "vms"
                StaticText :
                StaticText [
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "148e446b7e7089"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "01gtmj7swt42zpq48dqb4bgy8x.fly.dev"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "01GTK500PATD76RYGWGBTSK9KY"
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "stopped"
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-03-03T20:22:39.096Z"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-03-03T22:01:56.092Z"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "string"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText vms
                StaticText All the lines returned in the log.
                code
                    StaticText id
                StaticText The ID of the VM.
                code
                    StaticText state
                StaticText The status of the VM.
                code
                    StaticText imageId
                StaticText The image ID of the VM.
                code
                    StaticText hostname
                StaticText The hostname used to access this VM.
                code
                    StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                code
                    StaticText memory
                StaticText The amount of memory allocated for this VM, in MB.
                code
                    StaticText state
                StaticText The current state of the VM.
                code
                    StaticText createdAt
                StaticText The date and time this VM was created.
                code
                    StaticText updatedAt
                StaticText The date and time this VM was last updated.
                code
                    StaticText port
                StaticText (optional) The port (if any) allocated for this VM.
                code
                    StaticText volumeGB
                StaticText (optional) The amount of disk storage, in GB, to attach to the VM.
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token with which you can fetch the next page.
            heading Cached VMs#​
                link #​, url='https://docs.cakework.com/reference/rest#cached-vms'
            paragraph
                StaticText Use these APIs for re-usable VMs. This helps you get much faster cold starts.
            heading cacheVM#​
                link #​, url='https://docs.cakework.com/reference/rest#cachevm'
            paragraph
                StaticText Cache a VM using an image. You still need to call
                code
                    StaticText startCachedVM
                StaticText to start a cached VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-10'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cache
            button Copy code to clipboard
            heading Request#​
                link #​, url='https://docs.cakework.com/reference/rest#request-4'
            code
                StaticText {
                StaticText "imageId"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "port"
                StaticText :
                StaticText 8080
                StaticText ,
                StaticText "envVars"
                StaticText :
                StaticText {
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "string"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText "diskSize"
                StaticText :
                StaticText 3
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText imageId
                StaticText The id of the image to cache the VM with.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs for the VM. Can be a number between 1 and 8.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory for the VM. Can be a number between 256 and 16384.
                strong
                    code
                        StaticText port
                StaticText (optional) The internal port to open.
                strong
                    code
                        StaticText envVars
                StaticText (optional) The evironment variables as a map of string to string.
                strong
                    code
                        StaticText diskSize
                StaticText (optional) The amount of persistent storage to attach to each VM, in GB. Can be a number between 1 and 500.
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-9'
            code
                StaticText {
                StaticText "id"
                StaticText :
                StaticText "e784996f346483"
                StaticText ,
                StaticText "hostname"
                StaticText :
                StaticText "01gv2zfbt345trtrdk6vhbeccz.fly.dev"
                StaticText ,
                StaticText "cpu"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "memory"
                StaticText :
                StaticText 256
                StaticText ,
                StaticText "imageId"
                StaticText :
                StaticText "01GTZHKS9CZHQ1NKZCA3LG0H4D"
                StaticText ,
                StaticText "state"
                StaticText :
                StaticText "stopped"
                StaticText ,
                StaticText "volumeGB"
                StaticText :
                StaticText 1
                StaticText ,
                StaticText "createdAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText ,
                StaticText "updatedAt"
                StaticText :
                StaticText "2023-03-09T02:43:30.243-08:00"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText id
                StaticText The id used to reference this VM.
                strong
                    code
                        StaticText hostname
                StaticText The hostname used to access this VM.
                strong
                    code
                        StaticText cpu
                StaticText The number of CPUs allocated for this VM.
                strong
                    code
                        StaticText memory
                StaticText The amount of memory allocated for this VM, in MB.
                strong
                    code
                        StaticText imageId
                StaticText The image ID of the Docker image this VM is running.
                strong
                    code
                        StaticText state
                StaticText The current state of the VM. Will be
                code
                    StaticText stopped
                StaticText after the call to cache the VM.
                strong
                    code
                        StaticText createdAt
                StaticText The date and time this VM was created.
                strong
                    code
                        StaticText updatedAt
                StaticText The date and time this VM was last updated.
                strong
                    code
                        StaticText port
                StaticText (optional) The port (if any) allocated for this VM.
                strong
                    code
                        StaticText volumeGB
                StaticText (optional) The amount of disk storage, in GB, to attach to the VM.
            heading startCachedVM#​
                link #​, url='https://docs.cakework.com/reference/rest#startcachedvm'
            paragraph
                StaticText Start a cached VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-11'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cached/[cachedVmId]/start
            button Copy code to clipboard
            heading stopCachedVM#​
                link #​, url='https://docs.cakework.com/reference/rest#stopcachedvm'
            paragraph
                StaticText Stop a cached VM. You can stop the cached VM by exiting the process as well.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-12'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cached/[cachedVmId]/stop
            button Copy code to clipboard
            heading destroyCachedVM#​
                link #​, url='https://docs.cakework.com/reference/rest#destroycachedvm'
            paragraph
                StaticText Destroy a cached VM.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-13'
            StaticText POST
            code
                StaticText https://api.cakework.com/v1/vm/cached/[cachedVmId]/destroy
            button Copy code to clipboard
            heading Function#​
                link #​, url='https://docs.cakework.com/reference/rest#function'
            paragraph
                StaticText Use these APIs to deploy a function.
            heading getBuildLogs#​
                link #​, url='https://docs.cakework.com/reference/rest#getbuildlogs-1'
            paragraph
                StaticText Get logs for a build.
            heading Endpoint#​
                link #​, url='https://docs.cakework.com/reference/rest#endpoint-14'
            StaticText GET
            code
                StaticText https://api.cakework.com/v1/function/build/[buildId]/logs
            button Copy code to clipboard
            heading URL query Parameters#​
                link #​, url='https://docs.cakework.com/reference/rest#url-query-parameters-3'
            paragraph
                strong
                    code
                        StaticText query
                StaticText (optional) String to look for in the logs. Case-insensitive. If this parameter is not provided, all logs for the build are returned.
                strong
                    code
                        StaticText batch
                StaticText (optional) The number of rows to return. Accepts a range of 50-1000. Default: 100 rows.
                strong
                    code
                        StaticText order
                StaticText (optional) The order by timestamp to return the logs. Options are
                code
                    StaticText newest_first
                StaticText and
                code
                    StaticText oldest_first
                StaticText . Defaults to
                code
                    StaticText oldest_first
                StaticText .
                strong
                    code
                        StaticText pagination
                StaticText (optional) The pagination token returned by the previous call to get logs. Will be used to fetch the next batch of logs.
                strong
                    code
                        StaticText from
                StaticText (optional) Start of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000). If the call to
                code
                    StaticText getBuildLogs
                StaticText returns
                code
                    StaticText pagination
                StaticText ,
                code
                    StaticText from
                StaticText , and
                code
                    StaticText to
                StaticText fields, you must pass all 3 query parameters in the next call to
                code
                    StaticText getBuildLogs
                StaticText to fetch the next batch of logs.
                strong
                    code
                        StaticText to
                StaticText (optional) End of time range for the log query (ISO8601-formatted string: 2022-07-19T13:32:56+0000).
            heading Response#​
                link #​, url='https://docs.cakework.com/reference/rest#response-10'
            code
                StaticText {
                StaticText "lines"
                StaticText :
                StaticText [
                StaticText {
                StaticText "timestamp"
                StaticText :
                StaticText 1676625938460
                StaticText ,
                StaticText "level"
                StaticText :
                StaticText "string"
                StaticText ,
                StaticText "message"
                StaticText :
                StaticText "string"
                StaticText }
                StaticText ,
                StaticText ]
                StaticText ,
                StaticText "pagination"
                StaticText :
                StaticText "XlG9SZP"
                StaticText ,
                StaticText "from"
                StaticText :
                StaticText "2023-03-07 06:12:56 UTC"
                StaticText ,
                StaticText "to"
                StaticText :
                StaticText "2023-03-08 06:11:56 UTC"
                StaticText }
            button Copy code to clipboard
            paragraph
                strong
                    code
                        StaticText lines
                StaticText All the lines returned in the log.
                code
                    StaticText timestamp
                StaticText The unix timestamp in ms.
                code
                    StaticText level
                StaticText The log level (e.g. info/error).
                code
                    StaticText message
                StaticText The message.
                strong
                    code
                        StaticText pagination
                StaticText (optional) If present, the pagination token with which you can query for more logs.
                strong
                    code
                        StaticText from
                StaticText (optional) If present, the next from timestamp with which you can query for more logs.
                strong
                    code
                        StaticText to
                StaticText (optional) If present, the next to timestamp with which you can query for more logs.
        navigation Docs pages navigation
            link Previous « Getting Started, url='https://docs.cakework.com/'
            link Next Typescript », url='https://docs.cakework.com/reference/typescript'
        list
            listitem
                [2115] link Images, center=(1610,449), url='https://docs.cakework.com/reference/rest#images'
                list
                    listitem
                        [2118] link importImage, center=(1614,478), url='https://docs.cakework.com/reference/rest#importimage'
                    listitem
                        [2120] link buildImageFromFiles, center=(1614,507), url='https://docs.cakework.com/reference/rest#buildimagefromfiles'
                    listitem
                        [2122] link buildImageFromGithub, center=(1614,536), url='https://docs.cakework.com/reference/rest#buildimagefromgithub'
                    listitem
                        [2124] link getBuild, center=(1614,565), url='https://docs.cakework.com/reference/rest#getbuild'
                    listitem
                        [2126] link getBuildLogs, center=(1614,594), url='https://docs.cakework.com/reference/rest#getbuildlogs'
            listitem
                [2128] link VMs, center=(1610,623), url='https://docs.cakework.com/reference/rest#vms'
                list
                    listitem
                        [2131] link startVM, center=(1614,652), url='https://docs.cakework.com/reference/rest#startvm'
                    listitem
                        [2133] link stopVM, center=(1614,681), url='https://docs.cakework.com/reference/rest#stopvm'
                    listitem
                        [2135] link getVMLogs, center=(1614,711), url='https://docs.cakework.com/reference/rest#getvmlogs'
                    listitem
                        [2137] link getVm, center=(1614,740), url='https://docs.cakework.com/reference/rest#getvm'
                    listitem
                        [2139] link listVMs, center=(1614,769), url='https://docs.cakework.com/reference/rest#listvms'
            listitem
                [2141] link Cached VMs, center=(1610,798), url='https://docs.cakework.com/reference/rest#cached-vms'
                list
                    listitem
                        [2144] link cacheVM, center=(1614,827), url='https://docs.cakework.com/reference/rest#cachevm'
                    listitem
                        [2146] link startCachedVM, center=(1614,856), url='https://docs.cakework.com/reference/rest#startcachedvm'
                    listitem
                        [2148] link stopCachedVM, center=(1614,885), url='https://docs.cakework.com/reference/rest#stopcachedvm'
                    listitem
                        [2150] link destroyCachedVM, center=(1614,914), url='https://docs.cakework.com/reference/rest#destroycachedvm'
            listitem
                [2152] link Function, center=(1610,943), url='https://docs.cakework.com/reference/rest#function'
                list
                    listitem
                        [2155] link getBuildLogs, center=(1614,973), url='https://docs.cakework.com/reference/rest#getbuildlogs-1'
    contentinfo
        link GitHub, url='https://github.com/usecakework'
        StaticText ·
        link Discord, url='https://discord.gg/yB6GvheDcP'
        StaticText ·
        link Email, url='mailto:hi@cakework.com'
        StaticText Copyright © 2023 Sahale, Inc.

Reasoning for action: By clicking on the 'importImage' link, I moved from the general overview of the REST API documentation to the specific details regarding the 'importImage' function. This step is crucial as it directly addresses the user's need to understand how to utilize this function in their applications. The documentation will provide all necessary information such as endpoint, request parameters, and responses associated with the 'importImage' function.

Action: click(167) # Click on the 'importImage' link to explore the details of this API function.

Change Description: The browser navigated to the 'importImage' section of the Cakework REST documentation, changing the URL to 'https://docs.cakework.com/reference/rest#importimage', where users can now view details about importing an image from an existing AWS ECR Docker repository.

Screenshot before:Screenshot after:---