Access Policy API5

Access Policy Approval Procedure API5

Access Profile API5

Access Relationship API5

Access Request API6

App Instance API6

App Resource API8

App Resource Role API7

Approval Delegation API5

Approval Request API5

Audit Log API1

Auth API1

Custom Field API1

Custom Service API5

Entity API8

Entity Field Mapping API6

Entity Ingestion Config API8

Entity Type API13

Folder API7

Group API5

Guidance API6

Journey API2

Schedule API2

SLA API5

Tag API8

Team API5

Team User API5

Ticket API31

Topic API1

User API6

User Relationship API2

Workflow API7

Workflow Approval Procedure API5

Workflow Run API5

App Instance API

Update App Instance

Update an existing app instance.

put/v2/app-instances/{id}

Request

Base URL
https://public.api.serval.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/serval/apis/serval-public-api/docs/v2/app-instances/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The ID of the app instance.

Request body

externalServiceInstanceIdstring

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

namestring

The name of the app instance.

defaultAccessPolicyIdstring nullable

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

accessRequestsEnabledboolean

Whether access requests are enabled for the app instance.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.