Update (Server)

URL:
https://<root>/orgs/<orgID>/federation/servers/<serverID>/update
Methods:
POST
Required Capability:
Access allowed with the "Servers" privilege
Version Introduced:
11.2

Description

The update operation modifies the server role and server function of a federated server. Once federated, some servers will need to be updated using this operation to assign it its appropriate server function, which ensures the federated server is provided the appropriate resources and requirements it needs to operate according to its function type. At ArcGIS Enterprise on Kubernetes 11.2, this operation can be used to assign federated servers the WorkflowManager function.

Modify server roles

When modifying server roles, a server can be set as a federated server or be modified to a federated server that has a restrictive access model enabled that controls who has administrative and publisher access to the federated server.

Setting the server role as FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING will immediately restrict access to the federated server to only organization administrators. Organization members that have been assigned publisher privileges cannot access the federated server unless they are added to the publisher-specific group for the federated server or have the publisher-specific item shared to a group they belong to.

Modify server functions

At ArcGIS Enterprise on Kubernetes 11.2, the only server function a federated server can be assigned is WorkflowManager. To configure a federated server as an ArcGIS Workflow Manager Server, the federated server must be an ArcGIS Workflow Manager Server with appropriate licensing.

Request parameters

ParameterDetails

serverRole

Specifies whether the server is a federated server or a federated server with restricted access to publishing.

Values: FEDERATED_SERVER | FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING

serverFunction

Specifies the functions for the federated server. The server can be assigned any of the values listed below as long as the server meets the requirements for each functional area. At 11.2, the only supported value for serverFunction is WorkflowManager.

Values: WorkflowManager

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:

1
2
3
4
5
6
POST /context/admin/orgs/0123456789ABCDEF/federation/servers/SHsQDdugnlgV0dvc/update HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

serverRole=FEDERATED_SERVER&serverFunction=WorkflowManager&f=pjson&token=pY3M_DuL7hEVVDhmLm6viSeZdZmAUNt0zub84D9bHL0dlLZ7CEEnyha1CwYLFa4W0avZ6lMntBgG3GtsTf6sHO4Mp6ML0jNIkhDqsdjAnhmTGNLNPr_uMw4DFY0oiK9MoPIlBI4byQpRkBM9k0TjHPfoeqGJZh_BOxegje_1F_43rIrQ__e2nDo77SMSXHmy46FixGIq3TjnXV339UiSMqwGeILQCND9qdMcibegIV7DhIYna9ouFdf3inbyy4bU

JSON Response example

1
2
3
4
{
  "serverId": "SHsQDdugnlgV0dvc",
  "status": "success"
}

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close