URL:
https://<root>/portals/[portalID]/aiServer/disable
Methods:
POST
Version Introduced:
12.2

Example usage

The following is a sample ArcGIS Enterprise POST request for the disable operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
POST /<context>/sharing/rest/portals/0123456789ABCDEF/aiServer/disable HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryyhXptJlpBtsY1lI1
Content-Length: []

------WebKitFormBoundaryyhXptJlpBtsY1lI1
Content-Disposition: form-data; name="capability"

aiAssistants
------WebKitFormBoundaryyhXptJlpBtsY1lI1
Content-Disposition: form-data; name="f"

pjson
------WebKitFormBoundaryyhXptJlpBtsY1lI1
Content-Disposition: form-data; name="token"

<token>
------WebKitFormBoundaryyhXptJlpBtsY1lI1--

Description

The disable operation removes stored ArcGIS Online credentials for use with a specific AI capability. Removing these credentials prevents further use of the capability until new ArcGIS Online credentials are added. This operation can only be performed by administrators assigned the default administrator role or administrators that have been assigned a custom role that includes the Security and Infrastructure administrative privilege.

While members will no longer be able to use an AI capability when its stored credentials are removed, AI-related endpoints and information will remain accessible in the API if the organization has enabled the use of AI capabilities. To fully disable access to AI-related endpoints and to hide all AI-related information (such as helperServices), or to disable a specific AI capability for organization members, administrators must use the Update Settings operation.

It is recommended that the workflow for enabling AI capabilities, as well as storing and updating credentials, is performed from the portal site's organization settings page.

Request parameters

ParameterDetails

capability

(Required)

Specifies the AI capability that will have its stored credentials removed.

Values: aiAssistants | aiServices | aiAgents

f

The response format. The default format is html.

Values: html | json | pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
{
  "success": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.