Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Coder Provider
  3. API Docs
  4. App
coder 2.4.0-pre1 published on Tuesday, Apr 15, 2025 by coder
coder/terraform-provider-coder

coder.App

Explore with Pulumi AI

coder 2.4.0-pre1 published on Tuesday, Apr 15, 2025 by coder
coder/terraform-provider-coder

Use this resource to define shortcuts to access applications in a workspace.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as coder from "@pulumi/coder";

const me = coder.getWorkspace({});
const dev = new coder.Agent("dev", {
    os: "linux",
    arch: "amd64",
    dir: "/workspace",
    startupScript: `curl -fsSL https://code-server.dev/install.sh | sh
code-server --auth none --port 13337
`,
});
const code_server = new coder.App("code-server", {
    agentId: dev.agentId,
    slug: "code-server",
    displayName: "VS Code",
    icon: me.then(me => `${me.accessUrl}/icon/code.svg`),
    url: "http://localhost:13337",
    share: "owner",
    subdomain: false,
    openIn: "window",
    healthcheck: {
        url: "http://localhost:13337/healthz",
        interval: 5,
        threshold: 6,
    },
});
const vim = new coder.App("vim", {
    agentId: dev.agentId,
    slug: "vim",
    displayName: "Vim",
    icon: me.then(me => `${me.accessUrl}/icon/vim.svg`),
    command: "vim",
});
Copy
import pulumi
import pulumi_coder as coder

me = coder.get_workspace()
dev = coder.Agent("dev",
    os="linux",
    arch="amd64",
    dir="/workspace",
    startup_script="""curl -fsSL https://code-server.dev/install.sh | sh
code-server --auth none --port 13337
""")
code_server = coder.App("code-server",
    agent_id=dev.agent_id,
    slug="code-server",
    display_name="VS Code",
    icon=f"{me.access_url}/icon/code.svg",
    url="http://localhost:13337",
    share="owner",
    subdomain=False,
    open_in="window",
    healthcheck={
        "url": "http://localhost:13337/healthz",
        "interval": 5,
        "threshold": 6,
    })
vim = coder.App("vim",
    agent_id=dev.agent_id,
    slug="vim",
    display_name="Vim",
    icon=f"{me.access_url}/icon/vim.svg",
    command="vim")
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/coder/v2/coder"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		me, err := coder.GetWorkspace(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		dev, err := coder.NewAgent(ctx, "dev", &coder.AgentArgs{
			Os:            pulumi.String("linux"),
			Arch:          pulumi.String("amd64"),
			Dir:           pulumi.String("/workspace"),
			StartupScript: pulumi.String("curl -fsSL https://code-server.dev/install.sh | sh\ncode-server --auth none --port 13337\n"),
		})
		if err != nil {
			return err
		}
		_, err = coder.NewApp(ctx, "code-server", &coder.AppArgs{
			AgentId:     dev.AgentId,
			Slug:        pulumi.String("code-server"),
			DisplayName: pulumi.String("VS Code"),
			Icon:        pulumi.Sprintf("%v/icon/code.svg", me.AccessUrl),
			Url:         pulumi.String("http://localhost:13337"),
			Share:       pulumi.String("owner"),
			Subdomain:   pulumi.Bool(false),
			OpenIn:      pulumi.String("window"),
			Healthcheck: &coder.AppHealthcheckArgs{
				Url:       pulumi.String("http://localhost:13337/healthz"),
				Interval:  pulumi.Float64(5),
				Threshold: pulumi.Float64(6),
			},
		})
		if err != nil {
			return err
		}
		_, err = coder.NewApp(ctx, "vim", &coder.AppArgs{
			AgentId:     dev.AgentId,
			Slug:        pulumi.String("vim"),
			DisplayName: pulumi.String("Vim"),
			Icon:        pulumi.Sprintf("%v/icon/vim.svg", me.AccessUrl),
			Command:     pulumi.String("vim"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Coder = Pulumi.Coder;

return await Deployment.RunAsync(() => 
{
    var me = Coder.GetWorkspace.Invoke();

    var dev = new Coder.Agent("dev", new()
    {
        Os = "linux",
        Arch = "amd64",
        Dir = "/workspace",
        StartupScript = @"curl -fsSL https://code-server.dev/install.sh | sh
code-server --auth none --port 13337
",
    });

    var code_server = new Coder.App("code-server", new()
    {
        AgentId = dev.AgentId,
        Slug = "code-server",
        DisplayName = "VS Code",
        Icon = $"{me.Apply(getWorkspaceResult => getWorkspaceResult.AccessUrl)}/icon/code.svg",
        Url = "http://localhost:13337",
        Share = "owner",
        Subdomain = false,
        OpenIn = "window",
        Healthcheck = new Coder.Inputs.AppHealthcheckArgs
        {
            Url = "http://localhost:13337/healthz",
            Interval = 5,
            Threshold = 6,
        },
    });

    var vim = new Coder.App("vim", new()
    {
        AgentId = dev.AgentId,
        Slug = "vim",
        DisplayName = "Vim",
        Icon = $"{me.Apply(getWorkspaceResult => getWorkspaceResult.AccessUrl)}/icon/vim.svg",
        Command = "vim",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.coder.CoderFunctions;
import com.pulumi.coder.Agent;
import com.pulumi.coder.AgentArgs;
import com.pulumi.coder.App;
import com.pulumi.coder.AppArgs;
import com.pulumi.coder.inputs.AppHealthcheckArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var me = CoderFunctions.getWorkspace();

        var dev = new Agent("dev", AgentArgs.builder()
            .os("linux")
            .arch("amd64")
            .dir("/workspace")
            .startupScript("""
curl -fsSL https://code-server.dev/install.sh | sh
code-server --auth none --port 13337
            """)
            .build());

        var code_server = new App("code-server", AppArgs.builder()
            .agentId(dev.agentId())
            .slug("code-server")
            .displayName("VS Code")
            .icon(String.format("%s/icon/code.svg", me.applyValue(getWorkspaceResult -> getWorkspaceResult.accessUrl())))
            .url("http://localhost:13337")
            .share("owner")
            .subdomain(false)
            .openIn("window")
            .healthcheck(AppHealthcheckArgs.builder()
                .url("http://localhost:13337/healthz")
                .interval(5)
                .threshold(6)
                .build())
            .build());

        var vim = new App("vim", AppArgs.builder()
            .agentId(dev.agentId())
            .slug("vim")
            .displayName("Vim")
            .icon(String.format("%s/icon/vim.svg", me.applyValue(getWorkspaceResult -> getWorkspaceResult.accessUrl())))
            .command("vim")
            .build());

    }
}
Copy
resources:
  dev:
    type: coder:Agent
    properties:
      os: linux
      arch: amd64
      dir: /workspace
      startupScript: |
        curl -fsSL https://code-server.dev/install.sh | sh
        code-server --auth none --port 13337        
  code-server:
    type: coder:App
    properties:
      agentId: ${dev.agentId}
      slug: code-server
      displayName: VS Code
      icon: ${me.accessUrl}/icon/code.svg
      url: http://localhost:13337
      share: owner
      subdomain: false
      openIn: window
      healthcheck:
        url: http://localhost:13337/healthz
        interval: 5
        threshold: 6
  vim:
    type: coder:App
    properties:
      agentId: ${dev.agentId}
      slug: vim
      displayName: Vim
      icon: ${me.accessUrl}/icon/vim.svg
      command: vim
variables:
  me:
    fn::invoke:
      function: coder:getWorkspace
      arguments: {}
Copy

Create App Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new App(name: string, args: AppArgs, opts?: CustomResourceOptions);
@overload
def App(resource_name: str,
        args: AppArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        agent_id: Optional[str] = None,
        slug: Optional[str] = None,
        hidden: Optional[bool] = None,
        display_name: Optional[str] = None,
        external: Optional[bool] = None,
        healthcheck: Optional[AppHealthcheckArgs] = None,
        command: Optional[str] = None,
        icon: Optional[str] = None,
        open_in: Optional[str] = None,
        order: Optional[float] = None,
        share: Optional[str] = None,
        app_id: Optional[str] = None,
        subdomain: Optional[bool] = None,
        url: Optional[str] = None)
func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs args, CustomResourceOptions? opts = null)
public App(String name, AppArgs args)
public App(String name, AppArgs args, CustomResourceOptions options)

type: coder:App
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AppArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AppArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AppArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var appResource = new Coder.App("appResource", new()
{
    AgentId = "string",
    Slug = "string",
    Hidden = false,
    DisplayName = "string",
    External = false,
    Healthcheck = new Coder.Inputs.AppHealthcheckArgs
    {
        Interval = 0,
        Threshold = 0,
        Url = "string",
    },
    Command = "string",
    Icon = "string",
    OpenIn = "string",
    Order = 0,
    Share = "string",
    AppId = "string",
    Subdomain = false,
    Url = "string",
});
Copy
example, err := coder.NewApp(ctx, "appResource", &coder.AppArgs{
AgentId: pulumi.String("string"),
Slug: pulumi.String("string"),
Hidden: pulumi.Bool(false),
DisplayName: pulumi.String("string"),
External: pulumi.Bool(false),
Healthcheck: &.AppHealthcheckArgs{
Interval: pulumi.Float64(0),
Threshold: pulumi.Float64(0),
Url: pulumi.String("string"),
},
Command: pulumi.String("string"),
Icon: pulumi.String("string"),
OpenIn: pulumi.String("string"),
Order: pulumi.Float64(0),
Share: pulumi.String("string"),
AppId: pulumi.String("string"),
Subdomain: pulumi.Bool(false),
Url: pulumi.String("string"),
})
Copy
var appResource = new App("appResource", AppArgs.builder()
    .agentId("string")
    .slug("string")
    .hidden(false)
    .displayName("string")
    .external(false)
    .healthcheck(AppHealthcheckArgs.builder()
        .interval(0)
        .threshold(0)
        .url("string")
        .build())
    .command("string")
    .icon("string")
    .openIn("string")
    .order(0)
    .share("string")
    .appId("string")
    .subdomain(false)
    .url("string")
    .build());
Copy
app_resource = coder.App("appResource",
    agent_id="string",
    slug="string",
    hidden=False,
    display_name="string",
    external=False,
    healthcheck={
        "interval": 0,
        "threshold": 0,
        "url": "string",
    },
    command="string",
    icon="string",
    open_in="string",
    order=0,
    share="string",
    app_id="string",
    subdomain=False,
    url="string")
Copy
const appResource = new coder.App("appResource", {
    agentId: "string",
    slug: "string",
    hidden: false,
    displayName: "string",
    external: false,
    healthcheck: {
        interval: 0,
        threshold: 0,
        url: "string",
    },
    command: "string",
    icon: "string",
    openIn: "string",
    order: 0,
    share: "string",
    appId: "string",
    subdomain: false,
    url: "string",
});
Copy
type: coder:App
properties:
    agentId: string
    appId: string
    command: string
    displayName: string
    external: false
    healthcheck:
        interval: 0
        threshold: 0
        url: string
    hidden: false
    icon: string
    openIn: string
    order: 0
    share: string
    slug: string
    subdomain: false
    url: string
Copy

App Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The App resource accepts the following input properties:

AgentId This property is required. string
The id property of a coder.Agent resource to associate with.
Slug This property is required. string
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
AppId string
The ID of this resource.
Command string
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
DisplayName string
A display name to identify the app. Defaults to the slug.
External bool
Specifies whether url is opened on the client machine instead of proxied through the workspace.
Healthcheck AppHealthcheck
HTTP health checking to determine the application readiness.
Hidden bool
Determines if the app is visible in the UI (minimum Coder version: v2.16).
Icon string
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
OpenIn string
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
Order double
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
Share string
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
Subdomain bool
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
Url string
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
AgentId This property is required. string
The id property of a coder.Agent resource to associate with.
Slug This property is required. string
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
AppId string
The ID of this resource.
Command string
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
DisplayName string
A display name to identify the app. Defaults to the slug.
External bool
Specifies whether url is opened on the client machine instead of proxied through the workspace.
Healthcheck AppHealthcheckArgs
HTTP health checking to determine the application readiness.
Hidden bool
Determines if the app is visible in the UI (minimum Coder version: v2.16).
Icon string
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
OpenIn string
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
Order float64
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
Share string
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
Subdomain bool
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
Url string
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
agentId This property is required. String
The id property of a coder.Agent resource to associate with.
slug This property is required. String
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
appId String
The ID of this resource.
command String
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
displayName String
A display name to identify the app. Defaults to the slug.
external Boolean
Specifies whether url is opened on the client machine instead of proxied through the workspace.
healthcheck AppHealthcheck
HTTP health checking to determine the application readiness.
hidden Boolean
Determines if the app is visible in the UI (minimum Coder version: v2.16).
icon String
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
openIn String
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
order Double
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
share String
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
subdomain Boolean
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
url String
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
agentId This property is required. string
The id property of a coder.Agent resource to associate with.
slug This property is required. string
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
appId string
The ID of this resource.
command string
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
displayName string
A display name to identify the app. Defaults to the slug.
external boolean
Specifies whether url is opened on the client machine instead of proxied through the workspace.
healthcheck AppHealthcheck
HTTP health checking to determine the application readiness.
hidden boolean
Determines if the app is visible in the UI (minimum Coder version: v2.16).
icon string
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
openIn string
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
order number
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
share string
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
subdomain boolean
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
url string
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
agent_id This property is required. str
The id property of a coder.Agent resource to associate with.
slug This property is required. str
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
app_id str
The ID of this resource.
command str
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
display_name str
A display name to identify the app. Defaults to the slug.
external bool
Specifies whether url is opened on the client machine instead of proxied through the workspace.
healthcheck AppHealthcheckArgs
HTTP health checking to determine the application readiness.
hidden bool
Determines if the app is visible in the UI (minimum Coder version: v2.16).
icon str
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
open_in str
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
order float
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
share str
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
subdomain bool
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
url str
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
agentId This property is required. String
The id property of a coder.Agent resource to associate with.
slug This property is required. String
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
appId String
The ID of this resource.
command String
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
displayName String
A display name to identify the app. Defaults to the slug.
external Boolean
Specifies whether url is opened on the client machine instead of proxied through the workspace.
healthcheck Property Map
HTTP health checking to determine the application readiness.
hidden Boolean
Determines if the app is visible in the UI (minimum Coder version: v2.16).
icon String
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
openIn String
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
order Number
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
share String
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
subdomain Boolean
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
url String
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.

Outputs

All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing App Resource

Get an existing App resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AppState, opts?: CustomResourceOptions): App
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_id: Optional[str] = None,
        app_id: Optional[str] = None,
        command: Optional[str] = None,
        display_name: Optional[str] = None,
        external: Optional[bool] = None,
        healthcheck: Optional[AppHealthcheckArgs] = None,
        hidden: Optional[bool] = None,
        icon: Optional[str] = None,
        open_in: Optional[str] = None,
        order: Optional[float] = None,
        share: Optional[str] = None,
        slug: Optional[str] = None,
        subdomain: Optional[bool] = None,
        url: Optional[str] = None) -> App
func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)
public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)
public static App get(String name, Output<String> id, AppState state, CustomResourceOptions options)
resources:  _:    type: coder:App    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AgentId string
The id property of a coder.Agent resource to associate with.
AppId string
The ID of this resource.
Command string
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
DisplayName string
A display name to identify the app. Defaults to the slug.
External bool
Specifies whether url is opened on the client machine instead of proxied through the workspace.
Healthcheck AppHealthcheck
HTTP health checking to determine the application readiness.
Hidden bool
Determines if the app is visible in the UI (minimum Coder version: v2.16).
Icon string
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
OpenIn string
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
Order double
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
Share string
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
Slug string
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
Subdomain bool
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
Url string
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
AgentId string
The id property of a coder.Agent resource to associate with.
AppId string
The ID of this resource.
Command string
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
DisplayName string
A display name to identify the app. Defaults to the slug.
External bool
Specifies whether url is opened on the client machine instead of proxied through the workspace.
Healthcheck AppHealthcheckArgs
HTTP health checking to determine the application readiness.
Hidden bool
Determines if the app is visible in the UI (minimum Coder version: v2.16).
Icon string
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
OpenIn string
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
Order float64
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
Share string
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
Slug string
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
Subdomain bool
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
Url string
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
agentId String
The id property of a coder.Agent resource to associate with.
appId String
The ID of this resource.
command String
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
displayName String
A display name to identify the app. Defaults to the slug.
external Boolean
Specifies whether url is opened on the client machine instead of proxied through the workspace.
healthcheck AppHealthcheck
HTTP health checking to determine the application readiness.
hidden Boolean
Determines if the app is visible in the UI (minimum Coder version: v2.16).
icon String
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
openIn String
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
order Double
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
share String
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
slug String
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
subdomain Boolean
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
url String
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
agentId string
The id property of a coder.Agent resource to associate with.
appId string
The ID of this resource.
command string
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
displayName string
A display name to identify the app. Defaults to the slug.
external boolean
Specifies whether url is opened on the client machine instead of proxied through the workspace.
healthcheck AppHealthcheck
HTTP health checking to determine the application readiness.
hidden boolean
Determines if the app is visible in the UI (minimum Coder version: v2.16).
icon string
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
openIn string
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
order number
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
share string
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
slug string
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
subdomain boolean
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
url string
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
agent_id str
The id property of a coder.Agent resource to associate with.
app_id str
The ID of this resource.
command str
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
display_name str
A display name to identify the app. Defaults to the slug.
external bool
Specifies whether url is opened on the client machine instead of proxied through the workspace.
healthcheck AppHealthcheckArgs
HTTP health checking to determine the application readiness.
hidden bool
Determines if the app is visible in the UI (minimum Coder version: v2.16).
icon str
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
open_in str
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
order float
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
share str
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
slug str
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
subdomain bool
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
url str
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.
agentId String
The id property of a coder.Agent resource to associate with.
appId String
The ID of this resource.
command String
A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either command or url may be specified, but not both.
displayName String
A display name to identify the app. Defaults to the slug.
external Boolean
Specifies whether url is opened on the client machine instead of proxied through the workspace.
healthcheck Property Map
HTTP health checking to determine the application readiness.
hidden Boolean
Determines if the app is visible in the UI (minimum Coder version: v2.16).
icon String
A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with "${data.coder_workspace.me.access_url}/icon/<path>".
openIn String
Determines where the app will be opened. Valid values are "tab" and "slim-window" (default). "tab" opens in a new tab in the same browser window. "slim-window" opens a new browser window without navigation controls.
order Number
The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
share String
Determines the level which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on coder server (Enterprise only).
slug String
A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
subdomain Boolean
Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with subdomain set to true will not be accessible. Defaults to false.
url String
An external url if external=true or a URL to be proxied to from inside the workspace. This should be of the form http://localhost:PORT[/SUBPATH]. Either command or url may be specified, but not both.

Supporting Types

AppHealthcheck
, AppHealthcheckArgs

Interval This property is required. double
Duration in seconds to wait between healthcheck requests.
Threshold This property is required. double
Number of consecutive heathcheck failures before returning an unhealthy status.
Url This property is required. string
HTTP address used determine the application readiness. A successful health check is a HTTP response code less than 500 returned before healthcheck.interval seconds.
Interval This property is required. float64
Duration in seconds to wait between healthcheck requests.
Threshold This property is required. float64
Number of consecutive heathcheck failures before returning an unhealthy status.
Url This property is required. string
HTTP address used determine the application readiness. A successful health check is a HTTP response code less than 500 returned before healthcheck.interval seconds.
interval This property is required. Double
Duration in seconds to wait between healthcheck requests.
threshold This property is required. Double
Number of consecutive heathcheck failures before returning an unhealthy status.
url This property is required. String
HTTP address used determine the application readiness. A successful health check is a HTTP response code less than 500 returned before healthcheck.interval seconds.
interval This property is required. number
Duration in seconds to wait between healthcheck requests.
threshold This property is required. number
Number of consecutive heathcheck failures before returning an unhealthy status.
url This property is required. string
HTTP address used determine the application readiness. A successful health check is a HTTP response code less than 500 returned before healthcheck.interval seconds.
interval This property is required. float
Duration in seconds to wait between healthcheck requests.
threshold This property is required. float
Number of consecutive heathcheck failures before returning an unhealthy status.
url This property is required. str
HTTP address used determine the application readiness. A successful health check is a HTTP response code less than 500 returned before healthcheck.interval seconds.
interval This property is required. Number
Duration in seconds to wait between healthcheck requests.
threshold This property is required. Number
Number of consecutive heathcheck failures before returning an unhealthy status.
url This property is required. String
HTTP address used determine the application readiness. A successful health check is a HTTP response code less than 500 returned before healthcheck.interval seconds.

Package Details

Repository
coder coder/terraform-provider-coder
License
Notes
This Pulumi package is based on the coder Terraform Provider.
coder 2.4.0-pre1 published on Tuesday, Apr 15, 2025 by coder
coder/terraform-provider-coder