- URL:
- https://<services-url>/properties
- Methods:
GET- Operations:
- Update
Access requirements
Required privileges
The Sever 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.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The properties resource is used to provide default settings for new services when they are published to ArcGIS Server.
You can use the Update Default Service Properties operation to change the default settings. The operation won't change the properties of any existing services; for that, you can use the Edit Service operation for a particular service.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| A JSON object that describes each property to be set. The only available property is:
|
Example usage
The following is a sample request URL used to access the properties resource:
https://organization.example.com/<context>/admin/services/properties?f=pjsonJSON Response example
{"preferSharedInstances": true}