Skip to main content
POST
Create App Instance

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

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

Body

application/json
teamId
string
required

The ID of the workspace.

externalServiceInstanceId
string
required

The external service instance ID (e.g., GitHub org name, Okta domain, AWS account ID).

name
string
required

The name of the app instance.

customServiceId
string
required

The ID of a custom service to create the app instance for.

defaultAccessPolicyId
string | null

The default access policy for the app instance (optional).

accessRequestsEnabled
boolean | null

Whether access requests are enabled for the app instance. Unset keeps the server default (enabled on creation).

owners
owners · object

Initial owners. Omit to create without owners.

Response

200 - application/json

Success

data
data · object

The created app instance.