Update - External Content | ArcGIS REST APIs

URL:: https://<root>/system/content/externalcontent/update
Methods:: POST
Version Introduced:: 11.2

Access requirements

Required privileges

The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Security and Infrastructure Organization Website

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.

Learn how to generate a token

Description

The update operation enables and disables access to Esri-provided content containing external URLs that reference sites and resources hosted outside of the organization. If external content is disabled, Esri content containing external URLs will be removed from the organization and will not be discoverable. This extends to any external content that would typically be included when enabling new languages for your organization; that is, when access to external content is disabled, all external content included with any added languages is also disabled.

If you enable external content, Esri content containing external URLs is added to the organization and is discoverable. By default, external content is enabled. This extends to any external content included when enabling new languages for the organization, enabling access to external content included with added languages.

Request parameters

Parameter Details

Parameter	Details
`externalContentEnabled`	Specifies whether the organization will allow Esri-provided external content. If `true`, outside resources and sites will be accessible to users in your organization. If `false`, access to this content will be unavailable. The default value is `true`. Values: `true` \| `false`
`async`	Introduced at ArcGIS Enterprise 12.0. This parameter specifies whether the operation is performed asynchronously. If set as `false`, the operation is performed synchronously and a response is only returned when external access for the organization is updated successfully or when the operation fails. If set as `true`, the operation is performed asynchronously and the JSON response returns a job URL that can be used to poll for job status updates. The default value is `false`. Values: `true` \| `false`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

externalContentEnabled

Specifies whether the organization will allow Esri-provided external content. If true, outside resources and sites will be accessible to users in your organization. If false, access to this content will be unavailable. The default value is true.

Values: true | false

async

Introduced at ArcGIS Enterprise 12.0. This parameter specifies whether the operation is performed asynchronously. If set as false, the operation is performed synchronously and a response is only returned when external access for the organization is updated successfully or when the operation fails. If set as true, the operation is performed asynchronously and the JSON response returns a job URL that can be used to poll for job status updates. The default value is false.

Values: true | false

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the update operation:

Use dark colors for code blocksCopy
POST /<context>/portaladmin/system/content/externalcontent/update HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

externalContentEnabled=false&async=false&f=pjson

JSON Response examples

The following response is returned when the operation is performed synchronously:

Use dark colors for code blocksCopy
{"status": "success"}

The following response is returned when the operation is performed asynchronously (async set as true):

Use dark colors for code blocksCopy
{
    "status": "submitted",
    "jobUrl": "https://organization.example.com/<context>/portaladmin/system/jobs/13188471-da83-455c-870b-c25d5cf7e778",
    "jobId": "13188471-da83-455c-870b-c25d5cf7e778"
}

The value for the jobUrl response property can be used to access the job resource, which can be polled to check the job's status:

Use dark colors for code blocksCopy
{
    "jobId": "13188471-da83-455c-870b-c25d5cf7e778",
    "isCancelled": false,
    "startTime": 1758832892675,
    "endTime": 0,
    "type": "updateContentInternal",
    "status": "EXECUTING",
    "username": "admin"
}

When the job is completed successfully, the following JSON response is returned:

Use dark colors for code blocksCopy
{
    "jobId": "13188471-da83-455c-870b-c25d5cf7e778",
    "isCancelled": false,
    "messages": [
        "Async update content completed, external content enabled setting : false"
    ],
    "startTime": 1758832892675,
    "endTime": 1758832926175,
    "type": "updateContentInternal",
    "results": {
        "messages": [
            "Async update content completed, external content enabled setting : false"
        ]
    },
    "status": "COMPLETED",
    "username": "admin"
}