Skip to main content
PUT
Update App Instance

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-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. Team keys must allow every team 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.

Path Parameters

id
string
required

The ID of the app instance.

Body

application/json
externalServiceInstanceId
string

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

name
string

The name of the app instance.

defaultAccessPolicyId
string | null

The default access policy for the app instance. Unset leaves the current policy unchanged. Must not be empty when set — an instance always has a default policy.

accessRequestsEnabled
boolean | null

Whether access requests are enabled for the app instance. Unset leaves the current setting unchanged.

owners
owners · object

Omit to leave owners unchanged. When present, replaces all owners; {} clears them.

Response

200 - application/json

Success

data
data · object

The updated app instance.