Skip to main content
POST
Create application

Body

application/json

Create a web or API application and its default environment in the project the API key is bound to.

name
string
required

Application name shown in the project.

Required string length: 1 - 100
environment
object
required

Default environment created with an application. Web and API applications require a public URL.

kind
enum<string>
default:WEB_APPLICATION

WEB_APPLICATION opens a browser. API_APPLICATION runs browserless HTTP tests. Defaults to WEB_APPLICATION. Mobile applications are not created by this endpoint.

Available options:
WEB_APPLICATION,
API_APPLICATION
description
string

Optional description stored on the application.

Maximum string length: 2000
projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

created
boolean
required

False when an unarchived application with this name already existed and was returned unchanged.

application
object
required