GeezerVison

Bases: BaseServer

An ArcGIS Server site used for hosting GIS web services.

This class can be directly instantied when working with stand-alone (unfederated) ArcGIS Server sites.

This class is not directly created when working with federated ArcGIS Server sites, instead use the ServerManager list() or get() methods.

# Usage Example 1: Get an object for an ArcGIS Server site federated with an ArcGIS Enterprise portal

gis = GIS(profile="your_ent_admin_profile")

hosting_server = gis.admin.servers.get(role="HOSTING_SERVER")

For stand-alone ArcGIS Server sites, directly create a Server instance.

# Usage Example 2: Get a stand-alone ArcGIS Server site that has Web Adaptor installed

server_base_url = "https://example.com"

gis_server = Server(url=f"{server_base_url}/web_adaptor/admin",
                    token_url=f"{server_base_url}/web_adaptor/tokens/generateToken",
                    username="admin_user",
                    password="admin_password")

# Usage Example 3: Get the ArcGIS Server site that is federated to an Enterprise (using ``gis``)

server_base_url = "https://example.com"
gis = GIS(profile="your_ent_admin_profile")
gis_server = Server(url=f"{server_base_url}/web_adaptor/admin",
                    gis = gis)

# Usage Example 4: Get the ArcGIS Server site that is federated to an Enterprise (using ``portal_connection``)

server_base_url = "https://example.com"
gis = GIS(profile="your_ent_admin_profile")
gis_server = Server(url=f"{server_base_url}/web_adaptor/admin",
                    portal_connection=gis._portal.con)

property content: ServicesDirectory

Gets the Services Directory which can help you discover information about services available on a particular server. A service represents a local GIS resource whose functionality has been made available on the server to a wider audience. For example, an ArcGIS Server administrator can publish a Pro map or ArcMap map document (.mxd) as a map service. Developers and clients can display the map service and query its contents.

The Services Directory is available as part of the REST services infrastructure available with ArcGIS Server installations. It enables you to list the services available, including secured services when you provide a proper login. For each service, a set of general properties are displayed. For map services, these properties include the spatial extent, spatial reference (coordinate system) and supported operations. Layers are also listed, with links to details about layers, which includes layer fields and extent. The Services Directory can execute simple queries on layers.

The Services Directory is also useful for finding information about non-map service types. For example, you can use the Services Directory to determine the required address format for a geocode service, or the necessary model inputs for a geoprocessing service.

Returns:

ServicesDirectory object

property datastores: DataStoreManager

Gets the information about the data holdings of the server. Data items are used by ArcGIS Pro, ArcGIS Desktop, and other clients to validate data paths referenced by GIS services. You can register new data items with the server by using the Register Data Item operation. Use the Find Data Items operation to search through the hierarchy of data items. A relational data store type represents a database platform that has been registered for use on a portal’s hosting server by the ArcGIS Server administrator. Each relational data store type describes the properties ArcGIS Server requires in order to connect to an instance of a database for a particular platform. At least one registered relational data store type is required before client applications such as Insights for ArcGIS can create Relational Database Connection portal items. The Compute Ref Count operation counts and lists all references to a specific data item. This operation helps you determine if a particular data item can be safely deleted or refreshed.

Returns:

DataStoreManager object

property logs: LogManager

Gives users access the ArcGIS Server’s logs and lets administrators query and find errors and/or problems related to the server or a service.

Logs are the records written by the various components of ArcGIS Server. You can query the logs and change various log settings. Note ArcGIS Server Only

Returns:

LogManager object

property machines: MachineManager

Gets the list of server machines registered with the site. This resource represents a collection of all the server machines that have been registered with the site. It other words, it represents the total computing power of your site. A site will continue to run as long as there is one server machine online. For a server machine to start hosting GIS services, it must be grouped (or clustered). When you create a new site, a cluster called ‘default’ is created for you. The list of server machines in your site can be dynamic. You can register additional server machines when you need to increase the computing power of your site or unregister them if you no longer need them.

Returns:

MachineManager object

property mode: Mode

ArcGIS Server site mode that allows you to control changes to your site. You can set the site mode to READ_ONLY to disallow the publishing of new services and block most administrative operations. Your existing services will continue to function as they did previously. Note that certain administrative operations such as adding and removing machines from a site are still available in READ_ONLY mode.

Returns:

Mode class

publish_sd(sd_file: str, folder: str | None = None, service_config: dict | None = None, future: bool = False, publish_options: dict | None = None, item_id: str | None = None) → bool

Publishes a service definition file to ArcGIS Server.

Parameter	Description
sd_file	Required string. The path to the service definition file to be uploaded and published.
folder	Optional string. The folder in which to publish the service definition file to. If this folder is not present, it will be created. The default is None in which case the service definition will be published to the System folder.
service_config	Optional Dict[str, Any]. A set of configuration overwrites that overrides the service definitions defaults.
future	Optional boolean. If True, the operation is returned immediately and a Job object is returned.
publish_options	Optional Dict[str, Any]. A set of specifications for the published item.
item_id	Optional string. The item ID of the item to be published. Must be a valid ID nonexistent in the server.

Returns:

If future=False, A boolean indicating success (True) or failure (False). else when future=True, a Future object is returned.

property resources: list

returns the list of resources available on the server administration endpoint.

property services: ServiceManager

Gives the administrator access to the services on ArcGIS Server

Returns:

ServiceManager or None

property site: SiteManager

Gets the site’s collection of server resources. This collection includes server machines that are installed with ArcGIS Server, including GIS services, data and so on. The site resource also lists the current version of the software. When you install ArcGIS Server on a server machine for the first time, you must create a new site. Subsequently, newer server machines can join your site and increase its computing power. Once a site is no longer required, you can delete the site, which will cause all of the resources to be cleaned up.

Returns:

SiteManager

property system: SystemManager

Provides access to common system configuration settings.

Returns:

SystemManager or None

property uploads: Uploads

Gets an object to work with the site uploads.

property usage: ReportManager

Gets the collection of all the usage reports created within your site. The Create Usage Report operation lets you define a new usage report.

Returns:

ReportManager or None

property users

Gets operations to work with users.

Returns:

UserManager object

Bases: BaseServer

Provides ArcGIS Server Services Directory access.

The Services Directory allows you to browse the contents of an ArcGIS Server and obtain information that can be useful to end-users for developing applications, performing analysis, or cataloging services. The ServicesDirectory is a view of the ArcGIS Server REST API in a python class.

With the Services Directory, you can do the following:

• Browse the contents of the GIS Server and get service-level metadata

• Navigate a series of links to view information about the services on your GIS Server.

• Get information to help you develop applications

When you develop applications with the Python API, you must provide URLs to services and the layers and functionality they expose. The Services Directory provides an interactive way for you to construct those URLs.

The Services Directory works using REST. REST is an architectural style that allows ArcGIS Server to reveal a hierarchy of information about itself through endpoints, or URLs. When you use the Services Directory, you navigate through a series of links to discover information about the server. Each time you click a link, you see a new page that reveals additional information about what’s available on the server. The information that you see on the page is retrieved through REST using the page’s URL.

find(service_name: str, folder: str | None = None)

finds a service based on it’s name in a given folder

property folders

returns a list of server folders

footprints(folder: str | None = None, out_sr: dict | None = None) → dict

Returns the Services’ extents for all services in a given folder.

Parameter	Description
folder	Optional String. The name of the folder to examine for the footprints.
out_sr	Optional Integer. The well-known ID of the spatial reference. The default is 4326.

Returns:

dict[str, Any]

get(name: str, folder: str | None = None)

returns a single service in a folder

list(folder: str | None = None, as_dict: bool = False) → list | dict[str, Any]

The list method returns a list of services at the given folder. The objects will vary in type according to the type of service. For example, Feature Services return FeatureLayerCollection objects, Geoprocessing Services return Toolbox objects, while Map Services return MapImageLayer objects.

Note

This method is not to be confused with the list method of the ServerManager class, which returns Server or NotebookServer objects, or the list method of the ServiceManager class, which returns a list of Service objects and modules.

report(as_html: bool = True, folder: str | None = None)

Generates a table of Services in the given folder, as a Pandas dataframe.

property session: EsriSession

returns the session for the ServiceDirectory

Bases: BaseServer

Represents a GIS administrative service

(This should not be created by a user)

change_provider(provider: str) → bool

Allows for the switching of the service provide and how it is hosted on the ArcGIS Server instance.

Values:

• ‘ArcObjects’ means the service is running under the ArcMap runtime i.e. published from ArcMap

• ‘ArcObjects11’: means the service is running under the ArcGIS Pro runtime i.e. published from ArcGIS Pro

• ‘DMaps’: means the service is running in the shared instance pool (and thus running under the ArcGIS Pro provider runtime)

Returns:

Boolean

delete() → bool

deletes a service from arcgis server

edit(service: dict, future: bool = False) → tuple[bool, dict] | tuple[bool, AsyncJob]

To edit a service, you need to submit the complete JSON representation of the service, which includes the updates to the service properties. Editing a service causes the service to be restarted with updated properties.

Parameter	Description
service	Required dict. The service JSON as a dictionary.
future	Optional bool. Allows the operation to be run asynchronously when True, else the operation is run synchronously.

Returns:

Boolean and the Service Message when future=False, or AsyncJob when future=True

property extensions: list

lists the extensions on a service

property iteminformation: ItemInformationManager

Returns the item information

Returns:

ItemInformationManager

property jobs: JobManager

returns a JobManager to manage asynchronous geoprocessing tasks

modify_extensions(extension_objects: list | None = None) → bool

enables/disables a service extension type based on the name

Parameter	Description
extension_objects	Required list. A list of new extensions.

Returns:

Boolean

rename(new_name: str) → bool

Renames this service to the new name

Parameter	Description
new_name	Required string. New name of the current service.

Returns:

Boolean

restart() → bool

restarts the current service

service_manifest(file_type: str = 'json') → str

The service manifest resource documents the data and other resources that define the service origins and power the service. This resource will tell you underlying databases and their location along with other supplementary files that make up the service.

Parameter	Description
file_type	Required string. This value can be json or xml. json return the manifest.json file. xml returns the manifest.xml file.

Returns:

string

start() → bool

starts the specific service

property statistics: dict

returns the stats for the service

property status: dict

returns the status of the service

stop() → bool

stops the current service

property webhook_manager: ServiceWebHookManager

Returns an instance of ServiceWebHookManager, the feature service-based webhook manager available at ArcGIS Server 11.1 and later.

Bases: object

represents a service extension

property allowed_upload_filetypes: str

gets/sets the allowed upload file type

property capabilities: str

gets/sets the capabilities

property enabled: bool

gets/sets the extension is enabled

static fromJSON(value: str | dict) → Extension

returns the object from json string or dictionary

property max_upload_file_size: int | float

sets/gets the max upload file size

property properties: dict

gets/sets the extension properties

property typeName: str

gets the extension type

property value: dict

returns the object as a dictionary

Bases: BaseServer

A resource to administer aspects of the machine on which the ArcGIS Portal or Server software has been installed. A site is composed of one or more server machines, each of which is registered with the site. The site’s machines work together to host GIS services and data, and provide administrative capabilities for the site. Each server machine is capable of performing all these administrative tasks and hence a site can be thought of as a distributed peer-to-peer network of machines. The server machine communicates with its peers over a range of TCP and UDP ports that can be configured using the edit operation

delete_certificate(certificate: str) → bool

Deletes a SSL certificate using the certificate alias.

Parameter	Description
certificate	Required string. The name of the certificate to delete

Returns:

String stating “success” or error message.

export_certificate(certificate: str) → str

Downloads an SSL certificate. The file returned by the server is an X.509 certificate. The downloaded certificate can then be imported into a client that is making HTTP requests.

Parameter	Description
certificate	Required string. The name of the certificate in the key store.

Returns:

The SSL certificate object.

generate_CSR(certificate: str) → dict

Generates a certificate signing request (CSR) for a self-signed certificate. A CSR is required by a CA to create a digitally signed version of your certificate. Supply the certificate object that was created with method ssl_certificate.

Parameter	Description
certificate	Required string. The name of the certificate in the key store.

Returns:

The CSR.

property hardware: dict

This resource displays hardware information for the machine in your ArcGIS Server site. It updates the information when it detects any change to the configuration of your machine, as well as each time the machine is restarted.

Returns:

Dict

import_CA_signed_certificate(certificate: str, ca_signed_certificate: str) → bool

Imports a certificate authority (CA)-signed SSL certificate into the key store.

Parameter	Description
certificate	Required string. The name of the certificate in the key store.
ca_signed_certificate	Required string. The multi-part POST parameter containing the signed certificate file.

Returns:

A boolean indicating success (True) or failure (False).

import_existing_server_certificate(alias: str, cert_password: str, cert_file: str) → bool

Imports an existing server certificate, stored in the PKCS #12 format, into the keystore. If the certificate is a CA-signed certificate, you must first import the CA root or intermediate certificate using the importRootCertificate operation.

Parameter	Description
alias	Required string. A unique name for the certificate that easily identifies it.
cert_password	Required string. The password to unlock the file containing the certificate.
cert_file	Required string. The multi-part POST parameter containing the certificate file.

Returns:

A boolean indicating success (True) or failure (False).

import_root_certificate(alias: str, root_CA_certificate: str) → dict

Imports a certificate authority’s (CA) root and intermediate certificates into the keystore.

To create a production quality CA-signed certificate, you need to add the CA’s certificates into the keystore that enables the SSL mechanism to trust the CA (and the certificates it is signed). While most of the popular CA’s certificates are already available in the keystore, you can use this operation if you have a custom CA or specific intermediate certificates.

Parameter	Description
alias	Required string. The name of the certificate.
root_CA_certificate	Required string. The multi-part POST parameter containing the certificate file.

Returns:

A boolean indicating success (True) or failure (False).

ssl_certificate(certificate: str)

Provides the self-signed certificate object.

Note

Even though a self-signed certificate can be used to enable SSL, it is recommended that you use a self-signed certificate only on staging or development servers.

Parameter	Description
certificate	Required string. The name of the certificate in the key store to grab information from.

Returns:

The certificate object.

property ssl_certificates: dict

Gets the list of all the certificates (self-signed and CA-signed) created for the server machine. The server securely stores these certificates inside a key store within the configuration store.

start() → bool

Starts this server machine. Starting the machine enables its ability to host GIS services.

Returns:

A boolean indicating success (True) or failure (False).

property status: dict

Gets the status/state of this machine.

stop() → bool

Stops this server machine. Stopping the machine disables its ability to host GIS services.

Returns:

A boolean indicating success (True) or failure (False).

synchronize() → bool

On occasion, one or more machines in a server site might be unavailable due to network issues or because they are down (intentionally or unintentionally). Once these machines become available again, they will need to synchronize with the site to pick up any changes made to the site during that downtime. This is done automatically by the site, but it is only a one-time attempt. If there are any issues with this synchronizing effort, a SEVERE message is logged.

This operation allows administrators to manually synchronize specific machines with the site. Synchronizing a machine with the site will reconfigure the machine and redeploy all services. This will take a few minutes. During this time, all administrative operations on the site will be blocked.

Returns:

Boolean

unregister() → bool

Removes this machine from the site. This server machine will no longer participate in the site or run any of the GIS services. All resources that were acquired by the server machine (memory, files, and so forth) will be released.

Typically, you should only invoke this operation if the machine is going to be shut down for extended periods of time, or if it is being upgraded.

Once a machine has been unregistered, you can create a new site or join an existing site.

Returns:

A boolean indicating success (True) or failure (False).

Bases: BaseServer

(This class should not be created by a user)

A utility class representing a single usage report returned by ArcGIS Server.

A Usage Report is used to obtain ArcGIS Server usage data for specified resources during a given time period. It specifies the parameters for obtaining server usage data, time range (parameters since, from_value, to_value), aggregation interval, and queries (which specify the metrics to be gathered for a collection of server resources, such as folders and services).

delete() → dict

Deletes this usage report.

Returns:

A JSON indicating success.

edit() → dict

Edits the usage report. To edit a usage report, submit the complete JSON representation of the usage report which includes updates to the usage report properties. The name of the report cannot be changed when editing the usage report.

Values are changed in the class, to edit a property like metrics, pass in a new value.

Returns:

A JSON indicating success.

query(query_filter: str | None = None) → dict

Retrieves server usage data for this report. This operation aggregates and filters server usage statistics for the entire ArcGIS Server site. The report data is aggregated in a time slice, which is obtained by dividing up the time duration by the default (or specified) aggregationInterval parameter in the report. Each time slice is represented by a timestamp, which represents the ending period of that time slice.

In the JSON response, the queried data is returned for each metric- resource URI combination in a query. In the report-data section, the queried data is represented as an array of numerical values. A response of null indicates that data is not available or requests were not logged for that metric in the corresponding time-slice.

Parameter	Description
query_filter	Optional string. The report data can be filtered by the machine where the data is generated. The filter accepts a comma-separated list of machine names; * represents all machines.

Returns:

A JSON containing the server usage data.

USAGE EXAMPLE 1: Filters for the specified machines

{"machines": ["WIN-85VQ4T2LR5N", "WIN-239486728937"]}

USAGE EXAMPLE 2: No filtering, all machines are accepted

{"machines": "*"}

Bases: BaseServer

Represents a single Datastore in the Data Store Manager.

property datasets: list

Gets the datasets in the data store (currently implemented for big data file shares).

delete() → bool

Unregisters this data item from the data store.

Returns:

A boolean indicating success (True) or failure (False).

property hints: dict

Gets the hints resource for a big data file share. Hints are advanced parameters to control the generation of a manifest.

Sets the hints resource for a big data file share. Hints are advanced parameters to control the generation of a manifest.

Upload a hints file for a big data file share item. This will replace the existing hints file. To apply the control parameters in the hints file and regenerate the manifest, use the editDataItem to edit the big data file share (using the same data store item as input) which will regenerate the manifest. When a manifest is regenerated, it will be updated only for datasets that have hints and for new datasets that are added to the existing big data file share location.

Parameter	Description
hints	Required string. The hints file to be uploaded.

property lifecycleinfos: dict[str, Any]

Returns information regarding when the data store item was created and last edited.

property manifest: dict

Gets the manifest resource for a big data file share.

property ref_count: dict

The total number of references to this data item that exist on the server. You can use this property to determine if this data item can be safely deleted or taken down for maintenance.

Returns:

A number indictaing the number of references to this data item.

regenerate() → bool

This regenerates the manifest for a big data file share. You can regenerate a manifest if you have added new data or if you have uploaded a hints file using the edit resource.

Returns:

Boolean. True = Success, False = Failure

update(item: str) → bool

Edits this data item to update its connection information.

Parameter	Description
item	Required string. The dict representation of the updated item.

Returns:

True if the data item was successfully updated, False if the update failed.

validate() → bool

Validates that this data item’s path (for file shares) or connection string (for databases) is accessible to every server node in the site. This is necessary for the data item to be registered and used successfully with the server’s data store.

Returns:

True if the data item was successfully validated.

Bases: dict

A resource representing a user in the user store that can administer ArcGIS Server.

add_role(role_name: str) → dict

Use this operation to assign roles to a user account when working with a user and role store that supports reads and writes. By assigning a role to a user, the user account automatically inherits all the role’s permissions.

Parameter	Description
role_name	Required string. A role name to assign to this user.

Returns:

A JSON indicating success.

delete() → bool

Deletes this user account.

Returns:

A JSON indicating success.

update(password: str | None = None, full_name: str | None = None, description: str | None = None, email: str | None = None) → bool

Updates this user account in the user store.

Parameter	Description
password	Optional string. The password for this user.
full_name	Optional string. A full name for this user.
description	Optional string. Provide comments or description for this user.
email	Optional string. An email for this user account.

Returns:

A JSON indicating success.

Bases: dict

Represents a single role on server.

delete() → bool

Deletes this current role.

Returns:

A boolean indicating success (True) or failure (False).

grant(username: str) → bool

Adds a user to this role.

Parmeters	Description
username	Required string. The account name to add to the role.

Returns:

A boolean indicating success (True) or failure (False).

set_privileges(privilege: str) → bool

Assigns a privilege to this role.

Administrative access to ArcGIS Server is modeled as three broad tiers of privileges:

• ADMINISTER - A role that possesses this privilege has unrestricted administrative access to ArcGIS Server.

• PUBLISH - A role with PUBLISH privilege can only publish GIS services to ArcGIS Server.

• ACCESS - No administrative access. A role with this privilege can only be granted permission to access one or more GIS services.

By assigning these privileges to one or more roles in the role store, ArcGIS Server’s security model supports role-based access control to its administrative functionality.

These privilege assignments are stored independent of ArcGIS Server’s role store. As a result, you don’t need to update your enterprise identity stores (like Active Directory).

Parameter	Description
privilege	Required string. The capability to assign to the role. Choices are ADMINISTER, PUBLISH, ACCESS

Returns:

A boolean indicating success (True) or failure (False).

update(description: str | None = None) → dict

Updates this role in the role store with new information. This operation is available only when the role store is a read-write store such as the default ArcGIS Server store.

Parameter	Description
description	Optional string. An optional field to add comments or a description for the role.

Returns:

A status dictionary.

Bases: object

Class for managing your ArcGIS servers in an ArcGIS Enteprise deployment. This class is not created by users directly, but rather an instance of this class is accessed using the servers property on the PortalAdminManager object. Administrators access the admin property on their gis connection to get the PortalAdminManager. Methods on the ServerManager object allow administrators to manage and qeury ArcGIS Servers.

# Accessing the ServerManger for an ArcGIS Enterprise organization
>>> from arcgis.gis import GIS
>>> gis = GIS(profile="your_enterprise_admin_profile")

>>> org_admin = gis.admin
>>> org_admin

< PortalAdminManager @ https://org.example.com/<web_adaptor>//portaladmin >

>>> server_mgr = org_admin.servers
>>> server_mgr

< ServerManager @ https://org.example.com/<web_adaptor>//portaladmin >

get(role: str | None = None, function: str | None = None)

Retrieves the ArcGIS Server(s) by role or function. While each argument is optional, at least one argument must be set with an allowed value other than None.

Parameter	Description
role	Optional string. Limits the returned ArcGIS Servers based on the server’s role as either a hosting server, a federated server, or a server with restricted access to publishing. The allowed values are: HOSTING_SERVER FEDERATED_SERVER FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING
function	Optional string. Limits the returned ArcGIS Servers based on the server’s function. Provide a comma-separated list of values. Options for server functions are: RasterAnalytics NotebookServer KnowledgeServer MissionServer WorkflowManager ImageHosting GeoEvent Server VideoServer

Returns:

List of server(s) objects that match the criteria.

list()

Retrieves all servers in a GIS, retrieving a list of admin services.

Note

This method is not to be confused with the list method on the ServicesDirectory class, which returns a variety of services, such as a Feature Service, Map Service, Vector Tile, Geoprocessing Service, etc.

Returns:

A list of all servers (in the form of admin service objects) found in the GIS.

property properties

The ServerManager properties

Returns:

Dict

update(server: str, role: str, function: str | None = None)

This operation allows you to set an ArcGIS Server federated with Portal for ArcGIS as the hosting server or to enforce fine-grained access control to a federated server. You can also remove hosting server status from an ArcGIS Server. To set a hosting server, an enterprise geodatabase must be registered as a managed database with the ArcGIS Server.

Parameter	Description
server	Required string. The arcgis.gis.Server object.
role	Required string. State whether the server is either a hosting server for the portal, a federated server, or a server with restricted access to publishing. The allowed values are HOSTING_SERVER, FEDERATED_SERVER, or FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING, respectively.
function	Optional string. The specific function associated with this server. Provide a comma-separated list of values, but it is not recommend that a single server have all the server functions. The allowed values are RasterAnalytics and ImageHosting.

Returns:

A status message of ‘success’ with the ID of the ArcGIS Server.

validate(verbose: bool = False) → bool | dict

This operation returns information on the status of ArcGIS Servers registered with Portal for ArcGIS.

Parameter	Description
verbose	Optional bool. If true a dictionary with any messages will be returned.

Returns:

True if all servers are functioning as expected, False if there is an issue with 1 or more of the Federated Servers.

when verbose=True the response will be a dictionary.

Bases: BaseServer

Helper class for managing services. This class is not created by users directly, but rather an instance is accessed using the services property of a Server object.

# Usage Example: Initializing a ServiceManager object
>>> from arcgis.gis import GIS
>>> gis = GIS(profile="your_enterprise_admin_profile")

>>> server_mgr = gis.admin.servers
>>> site_server = server_mgr.get(function="RasterAnalytics")

>>> rax_service_mgr = site_server.services
>>> rax_service_mgr

< ServiceManager @ https://example.url.com/rasteranalytics/admin/services >

create_folder(folder_name: str, description: str = '') → bool

Creates a unique folder name on AGS

Parameter	Description
folder_name	Required string. Name of the new folder.
description	Optional string. Description of what the folder is.

Returns:

Boolean

create_service(service: dict) → dict

Creates a new GIS service in the folder. A service is created by submitting a JSON representation of the service to this operation.

The JSON representation of a service contains the following four sections:

• Service Description Properties-Common properties that are shared by all service types. Typically, they identify a specific service.

• Service Framework Properties-Properties targeted towards the framework that hosts the GIS service. They define the life cycle and load balancing of the service.

• Service Type Properties -Properties targeted towards the core service type as seen by the server administrator. Since these properties are associated with a server object, they vary across the service types. The Service Types section in the Help describes the supported properties for each service.

• Extension Properties-Represent the extensions that are enabled on the service. The Extension Types section in the Help describes the supported out-of-the-box extensions for each service type.

Parameter	Description
service	Required dict. The service is the properties to create a service.

Returns:

Dict

Output:

dictionary status message

delete_folder(folder_name: str) → bool

Removes a folder on ArcGIS Server

Parameter	Description
folder_name	Required string. Name of the folder.

Returns:

Boolean

exists(folder_name: str, name: str | None = None, service_type: str | None = None) → bool

This operation allows you to check whether a folder or a service exists. To test if a folder exists, supply only a folder_name. To test if a service exists in a root folder, supply both serviceName and service_type with folder_name=None. To test if a service exists in a folder, supply all three parameters.

Parameter	Description
folder_name	Required string. The folder name to check for.
name	Optional string. The service name to check for.
service_type	Optional string. A service type. Allowed values: GeometryServer | ImageServer | MapServer | GeocodeServer | GeoDataServer | GPServer | GlobeServer | SearchServer

Returns:

Boolean

property folders: list

returns a list of all folders

list(folder: str | None = None, refresh: bool = True) → list

returns a list of services in the specified folder

Parameter	Description
folder	Required string. The name of the folder to list services from.
refresh	Optional boolean. Default is False. If True, the list of services will be requested to the server, else the list will be returned from cache.

Returns:

list

publish_sd(sd_file: str, folder: str | None = None, service_config: dict | None = None) → bool

publishes a service definition file to arcgis server

Parameter	Description
sd_file	Required string. File path to the .sd file.
folder	Optional string. This parameter allows for the override of the folder option set in the sd file.
service_config	Optional dictionary that can override parameters configured in the sd file. See CreateService for full details on key-value pairs.

Returns:

Boolean

property service_properties: dict[str, Any]

The properties resource returns the default settings for newly published services. Currently, the only supported property is preferSharedInstances. The preferSharedInstances property controls whether new, compatible services published from ArcGIS Pro will use shared or dedicated instances. This property can be modified using the update operation.

Parameter	Description
properties	Required dict[str,Any]. A JSON object that describes each property to be set. Currently, the only supported property is preferSharedInstances. When set to true, compatible services will use shared instances when first published. When set to false, they will use dedicated instances. The default is true.

Returns:

dict[str,Any]

session: EsriSession | None = None

property types: TypesManager

The types resource provides metadata about all service types and extensions that can be enabled on each service type. The services framework uses this information to validate a service and construct the various objects in the service. The metadata contains identifiers for each object, a default list of capabilities, properties, and other resource information (like WSDL and so forth). Type information for a specific service type can be accessed by appending the type name to this URL.

Returns:

TypesManager

Bases: BaseServer

This class provides management capabilities for a specific Server machine in an ArcGIS Enterprise deployment. Objects of this class are not meant to be initialized directly but are accessed by the machines property on a server.

# Usage Example: Accessing the machine for an ArcGIS Server
>>> from arcgis.gis import GIS
>>> gis = GIS(profile="your_enterprise_admin_profile")

>>> server_mgr = gis.admin.servers
>>> ra_server = server_mgr.get(function="RasterAnalytics")[0]
>>> ra_server

< Server @ https://organization.example.com/<web_adaptor>/admin >

>>> server_machine_mgr = ra_server.machines
>>> server_machine_mgr

< MachineManager @ https://organization.example.com/<web_adaptor>/admin/machines >

get(machine_name: str) → Machine

Provides the machine object for a given machine.

Parameter	Description
machine_name	Required string. The name of the server. Example: machines_obj.get(“SERVER.DOMAIN.COM”)

Returns:

Machine object

list() → list

Returns:

A list of machines that are part of the server configuration.

register(name: str, admin_url: str) → bool

For a server machine to participate in a site, it needs to be registered with the site. The server machine must have ArcGIS Server software installed and authorized.

Registering machines this way is a “pull” approach to growing the site and is a convenient way when a large number of machines need to be added to a site. A server machine can also choose to join a site.

Parameter	Description
name	Required string. The name of the server machine.
admin_url	Required string. The URL where the Administrator API is running on the server machine. Example: http: //<machineName>:6080/arcgis/admin

Returns:

A boolean indicating success (True) or failure (False).

rename(name: str, new_name: str) → bool

You must use this operation if one of the registered machines has undergone a name change. This operation updates any references to the former machine configuration.

By default, when the server is restarted, it is capable of identifying a name change and repairing itself and all its references. This operation is a manual call to handle the machine name change.

Parameter	Description
name	Required string. The former name of the server machine that is registered with the site.
new_name	Required string. The new name of the server machine.

Returns:

A boolean indicating success (True) or failure (False).

Bases: BaseServer

Helper class for the management of logs by administrators. Logs are the transaction records written by the various components of ArcGIS Server. You can query the logs, change various log settings, and check error messages for helping to determine the nature of an issue. This class is not meant to be initialized directly, but instead is accessed as the logs property on a Server object:

#Usage Example: Initializing a Server LogManager of federated server
>>> from arcgis.gis import GIS
>>> gis = GIS(profile="your_enterprise_admin_profile")

>>> server_mgr = gis.admin.servers
>>> host_server = server_mgr.get(role="HOSTING_SERVER")[0]
>>> log_mgr = host_server.logs

<LogManager at https://example_server.com/<web_adaptor>/admin/logs>

See the Server logs documentation for more details.

clean() → bool

Deletes all the log files on all server machines in the site. This is an irreversible operation.

This operation forces the server to clean the logs, which has the effect of freeing up disk space. However, it is not required that you invoke this operation because the server periodically purges old logs.

Returns:

A boolean indicating success (True) or failure (False).

count_error_reports(machine: str = '*') → dict

This operation counts the number of error reports (crash reports) that have been generated on each machine.

Parameter	Description
machine	Optional string. The name of the machine on which to count the reports. The default will return the count for all machines in a site.

Returns:

A dictionary with machine name and report count.

edit(level: str = 'WARNING', log_dir: str | None = None, max_age: int = 90, max_report_count: int = 10) → dict

Provides log editing capabilities for the entire site.

Parameter	Description
level	Optional string. The log level. Can be one of (in severity order): OFF, DEBUG, VERBOSE, FINE, INFO, WARNING, SEVERE. The default is WARNING.
log_dir	Optional string. The file path to the root of the log directory.
max_age	Optional integer. The number of days that a server should save a log file. The default is 90.
ax_report_count	Optional integer. The maximum number of error report files per machine. The default is 10.

Returns:

A JSON with the edited settings.

query(start_time: int | str | datetime | None = None, end_time: int | str | datetime | None = None, since_server_start: bool = False, level: str = 'WARNING', services: str = '*', machines: str = '*', server: str = '*', codes: list[int | str] | str | None = None, process_IDs: list[int | str] | str | None = None, export: bool = False, export_type: str = 'CSV', out_path: str | None = None, max_records_return: int = 5000)

The query operation on the logs resource provides a way to aggregate, filter, and page through logs across the entire site.

Parameter	Description
start_time	Optional integer, string or datetime. The most recent time to query. Default is current time. Time can be specified in: milliseconds since UNIX epoch - integer ArcGIS Server timestamp - string Python datetime object - datetime # Example for Unix Epoch: log_resp = log_mgr.query( start_time = 1312237040123, ... ) # Example for Timestamp: log_resp = log_mgr.query( start_time="2024-10-18T13:00:00", ... ) # Example for Datetime object: import datetime as dt starting_time = dt.datetime(2024, 10, 18, 13, 0, 0) log_resp = log_mgr.query( start_time=starting_time, ...)
end_time	Optional integer, string or datetime. The previous time to query from. Time can be specified in: milliseconds since UNIX epoch - integer ArcGIS Server timestamp - string Python datetime object - datetime Note If since_server_start=True, the default is all logs since the server was started.
since_server_start	Optional Bool. Gets only the records written since the server started (True). The default is False.
level	Optional String. Gets only the records with a log level at or more severe than the level declared here. Can be one of (in severity order): DEBUG VERBOSE FINE INFO WARNING SEVERE The default is WARNING.
services	Optional List of comma separated strings denoting service names. Query records related to a specific service(s). The default is “*”, which queries all services. Note The string format is Folder_name/<service_name>.<service_type>. For example: log_mgr.query( ... services="Hosted/streets.FeatureServer", ... )
machines	Optional String. Query records related to a specific machine. The default is all, “*”.
server	Optional String. Query records related to a specific server. The default is all, “*”.
codes	Optional List of integers and/or strings. Gets only the records with the specified codes, or between the range of codes. If no argument is provided, all codes are included. See Log codes overview for full details. Note Individual codes should be entered as integers. A range of codes must be entered as a string: res = log_manager.query( ... codes = ["6500-7000", 12018] ... )
process_IDs	Optional list or comma-separated string. Query by the machine process ID that logged the event.
export	Optional bool. Indicates whether to export the query results. The default is False. When True, out_path must also be provided for the results to be written to a file.
export_type	Optional String. The export file type. Choices are: CSV TAB The default is CSV.
out_path	Optional String. The path to download the log file to. When export is True and no path is provided, a temporary file is created. If the provided path has no extension, .csv or .txt is appended based on the export type. The path should end in .csv or .txt depending on the export type.
max_records_return	Optional Int. The maximum amount of records to return. Default is 5000

Returns:

A Python dictionary of the log items that match the query. If export option is set to True, the output log file path is returned.

Example: Query all services for specific codes:

from arcgis.gis import GIS
gis = GIS(profile="your_enterprise_admin_profile")

server_mgr = gis.admin.servers
log_mgr = server_mgr.logs

query_resp = log_mgr.query(
               start_time="2025-03-07T06:00:00",
               end_time="2025-02-07T06:00:00",
               codes=["7000-8000"],
               services="Hosted/water_mains.FeatureServer",
               level="WARNING"
             )

property settings: dict

Gets the current log settings.

Bases: BaseServer

A utility class for managing usage reports for ArcGIS Server.

create(reportname: str, queries: list, metadata: str | None = None, since: str = 'LAST_DAY', from_value: int | None = None, to_value: int | None = None, aggregation_interval: str | None = None) → dict

Creates a new usage report. A usage report is created by submitting a JSON representation of the usage report to this operation. See Create Usage Report for details on the REST request bundled by this method.

Parameter	Description
reportname	Required string. The unique name of the report.
queries	Required list of Python dictionaries for which to generate the report. Each dictionary has two keys: resourceURIs and metrics # Usage Example >>> server1.usage.create( ... queries = [ { "resourceURIs": [ "/services/Folder_name/", "Forest_loss.FeatureServer" ], "metrics": [ "RequestCount,RequestsFailed" ] } ] ... ) Each key’s corresponding value is a list of strings specifying a resource for which to gather metrics, or the metrics to gather, respectively. resourceURIs – Comma-separated list that specifies the services or folders for which to gather metrics, formatted as below: services/ - Entire Site services/Folder/ - Folder within a Site. Reports metrics aggregated across all services within that folder and any sub-folders. services/Folder/ServiceName.ServiceType - Service in a specified folder. services/Folder_name/Map_bv_999.MapServer service - If in the root folder Map_bv_999.MapServer metrics – Comma-separated string of specific measures to gather. RequestCount — the number of requests received RequestsFailed - the number of requests that failed RequestsTimedOut — the number of requests that timed out RequestMaxResponseTime — the maximum response time RequestAvgResponseTime - the average response time ServiceRunningInstancesMax — the maximum number of active service instances sampled at one-minute intervals for a specified service. Note For ArcGIS Enterprise deployments at 11.0 and below, if you include ServiceRunningInstancesMax, it must be the only metric included in the report. RequestAvgWaitTime — the average time all requests waited for an available instance RequestMaxWaitTime — the maximum time a request waited for an available instance RequestMinWaitTime — the minimum time a request waited for an available instance
metadata	Optional string. Any JSON object representing presentation tier data for the usage report, such as report title, colors, line-styles, etc. Also used to denote visibility in ArcGIS Server Manager for reports created with the Administrator Directory. To make any report created in the Administrator Directory visible to Manager, include “managerReport”:true in the metadata JSON object. When this value is not set (default), reports are not visible in Manager. This behavior can be extended to any client that wants to interact with the Administrator Directory. Any user-created value will need to be processed by the client.
since	Optional string. The time duration of the report. The supported values are: LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR, CUSTOM LAST_DAY represents a time range spanning the previous 24 hours. This is the default value. LAST_WEEK represents a time range spanning the previous 7 days. LAST_MONTH represents a time range spanning the previous 30 days. LAST_YEAR represents a time range spanning the previous 365 days. CUSTOM represents a time range that is specified using the from and to parameters.
from_value	Optional integer. Only valid when since is CUSTOM. The timestamp in milliseconds (since January 1, 1970, 00:00:00 GMT, the Unix epoch) for the beginning period of the report. # usage Example: import datetime as dt >>> sept1_2020 = int(dt.datetime(2020, 9, 1).timestamp()) * 1000 sept1_2020 1598943600000
to_value	Optional integer. Only valid when since is CUSTOM. The timestamp in milliseconds (since January 1, 1970, 00:00:00 GMT, the Unix epoch) for the ending period of the report. # usage Example: import datetime as dt now = int(dt.datetime.now().timestamp()) * 1000
aggregation_interval	Optional string. The aggregation interval in minutes. Server metrics are aggregated and returned for time slices aggregated using the specified aggregation interval. The time range for the report, specified using the since parameter (and from_value and to_value when since is CUSTOM) is split into multiple slices, each covering an aggregation interval. Server metrics are then aggregated for each time slice and returned as data points in the report data. When the aggregation_interval is not specified, the following defaults are used: LAST_DAY: 30 minutes LAST_WEEK: 4 hours LAST_MONTH: 24 hours LAST_YEAR: 1 week CUSTOM: 30 minutes up to 1 day, 4 hours up to 1 week, 1 day up to 30 days, and 1 week for longer periods. If the interval specified in Usage Reports Settings is more than the aggregationInterval, the interval is used instead.

Returns:

A Report object.

USAGE EXAMPLE:

import datetime as dt
from arcgis.gis import GIS

>>> gis = GIS(profile="your_ent_profile", verify_cert=False)

>>> gis_servers = gis.admin.servers.list()

>>> gis_server = gis_servers[1]

>>> now = int(dt.datetime.now().timestamp()) * 1000
>>> sept1_2020 = int(dt.datetime(2020, 9, 1).timestamp()) * 1000

>>> query_obj = [{"resourceURIs": ["services/Map_bv_999.MapServer"],
                  "metrics": ["RequestCount"]}]

>>> r = gis_server.usage.create(reportname="SampleReport",
                                queries=query_obj,
                                metadata="This could be any String or JSON Object.",
                                since="CUSTOM",
                                from_value=sept1_2020,
                                to_value=now)
>>> r

    <Report at https://server_url:6443/arcgis/admin/usagereports/SampleReport>

edit(interval: str, enabled: bool = True, max_history: int = 0) → dict

Edits the usage reports settings that are applied to the entire site.

Parameter	Description
interval	Required string. Defines the duration (in minutes) for which the usage statistics are aggregated or sampled, in-memory, before being written out to the statistics database.
enabled	Optional string. When usage reports are enabled, service usage statistics are collected and persisted to a statistics database. When usage reports are disabled, the statistics are not collected. The default is True (enabled).
max_history	Optional integer. The number of days after which usage statistics are deleted from the statistics database. If the max_history parameter is set to 0 (the default value), the statistics are persisted forever.

Returns:

A JSON message indicating success.

list() → list

Retrieves a list of reports on the server.

Returns:

A list of reports found.

quick_report(since: str = 'LAST_WEEK', queries: str = 'services/', metrics: str = 'RequestsFailed') → dict

Generates an on the fly usage report for a service, services, or folder. See Create Usage Report for full details on server reports.

Parameter	Description
since	Optional string. The time duration of the report. The supported values are: LAST_DAY represents a time range spanning the previous 24 hours. This is the default value. LAST_WEEK represents a time range spanning the previous 7 days. LAST_MONTH represents a time range spanning the previous 30 days. LAST_YEAR represents a time range spanning the previous 365 days.
queries	Opitonal string. A string of resources for which to generate the report. Specified as a comma-separated sting of services or folders for which to gather metrics. services/ – Entire Site. The default. services/Folder/ – Folder within a Site. Reports metrics aggregated across all services within that Folder and Sub-Folders. services/Folder/ServiceName.ServiceType – Service in a specified folder, for example: services/Folder_Name/Map_bv_999.MapServer services/Fodler_Name/ServiceName.ServiceType root folder – Service in the root folder Map_bv_999.MapServer. # Example: >>> my_server.usage.quick_report( ... queries = "services/Hydroligic_Data/Lake_algae.FeatureServer,services/Mountains" ... )
metrics	Optional string. Comma separated list of metrics to be reported. Supported metrics are: RequestCount – the number of requests received RequestsFailed – the number of requests that failed RequestsTimedOut – the number of requests that timed out RequestMaxResponseTime – the maximum response time RequestAvgResponseTime – the average response time ServiceRunningInstancesMax – the maximum number of running service instances, sampled at one-minute intervals for a specified service. Note For ArcGIS Enterprise deployments at 11.0 and below, if you include ServiceRunningInstancesMax, it must be the only metric included in the report. RequestAvgWaitTime— the average time all requests waited for an available instance RequestMaxWaitTime— the maximum time a request waited for an available instance RequestMinWaitTime— the minimum time a request waited for an available instance # Example: >>> my_server.usage.quick_report( ... metrics="RequestCount,RequestsFailed" )

Returns:

A Python dictionary of data on a successful query.

# Usage Example:

>>> gis = GIS(profile="my_own_portal", verify_cert=False)

>>> gis_servers = gis.admin.servers.list()

>>> srv = gis_servers[0]

>>> query_string = "services/Forests/Forests_degraded_2000.MapServer,services/Lakes/Lakes_drought_levels.MapServer"
>>> qk_report = srv.usage.quick_report(since = "LAST_MONTH",
                                       queries = query_string,
                                       metrics = "RequestCount,RequestsFailed")

>>> qk_report

    {'report': {'reportname': '1fa828eb31664485ae5c25c76c86e28d',
                'metadata': '{"temp":true,"title":"1fa828eb31664485ae5c25c76c86e28d","managerReport":false}',
                'time-slices': [1598914800000, 1599001200000, 1599087600000, ... 1601420400000],
                'report-data': [[{'resourceURI': 'services/Forests/Forests_degraded_2000.MapServer',
                                  'metric-type': 'RequestCount', 'data': [None, 17, 928, ... 20]},
                                 {'resourceURI': 'services/Forests/Forests_degraded_2000.MapServer',
                                  'metric-type': 'RequestsFailed', 'data': [None, 225, None, ... 0]},
                                 {'resourceURI': 'services/Lakes/Lakes_drought_levels.MapServer',
                                  'metric-type': 'RequestCount', 'data': [0, 0, 7, ... 71]},
                                 {'resourceURI': 'services/Lakes/Lakes_drought_levels.MapServer',
                                  'metric-type': 'RequestsFailed', 'data': [None, None, 1 ... , 0]}]]}}

property settings: dict

Gets the current usage reports settings. The usage reports settings are applied to the entire site. When usage reports are enabled, service usage statistics are collected and persisted to a statistics database. When usage reports are disabled, the statistics are not collected. The interval parameter defines the duration (in minutes) during which the usage statistics are sampled or aggregated (in-memory) before being written out to the statistics database. Database entries are deleted after the interval specified in the max_history parameter ( in days), unless the max_history parameter is 0, for which the statistics are persisted forever.

Bases: BaseServer

This resource provides information about the data holdings of the server, as well as the ability to manage (add new items, update primary data store, remove a data store item, etc) the data store. Data items are used by ArcGIS Pro, ArcGIS Desktop, and other clients to validate data paths referenced by GIS services.

add(item: dict) → Datastore

Registers a new data item with the data store.

Parameter	Description
item	Required String, Dict. The dictionary representing the data item. See https://developers.arcgis.com/rest/enterprise-administration/server/dataitem.htm

Returns:

The data item if registered successfully, None otherwise.

add_bigdata(name: str, server_path: str | None = None, connection_type: str = 'fileShare') → Datastore

Registers a bigdata fileshare with the data store.

Parameter	Description
name	Required string. The unique bigdata fileshare name on the server.
server_path	Optional string. The path to the folder from the server.
connection_type	Optional string. Allows for the setting of the types of big data store. The value ‘fileShare’ is used for local big data stores, and for cloud stores, the connection_type should be ‘dataStore’. The value ‘fileShare’ is the default value.

Returns:

The big data fileshare if registered successfully, None otherwise.

add_cloudstore(name: str, conn_str: str, object_store: str, provider: str, managed: bool = False, folder: str | None = None) → Datastore

Cloud Store data item represents a connection to a Amazon or Microsoft Azure store. Connection information for the data store item is stored within conn_str as a stringified JSON. ArcGIS Server encrypts connection string for storage. Connection strings that are encrypted will include a {crypt} prefix. You can get a data store item with decrypted connection string by passing a decrypt=true parameter in the request for a data store item. Data store with decrypted connection string will be returned only for requests made with https. The examples below show data stores with decrypted conn_str. A valid object_store (S3 bucket or Azure Blob store) is required. Folders within an object store are optional.

Parameter	Description
name	Required string. The name of the cloud store.
conn_str	Required string. The connection information for the cloud storage product.
object_store	Required string. This is the amazon bucket path or Azuze path.
provider	Required string. Values must be amazon or azure.
managed	Optional boolean. When the data store is server only, the database is entirely managed and owned by the server and cannot be accessed by the publisher directly. When this option is chosen, the managed property should be set to true. Otherwise it is false.
folder	Optional string. For some Azure cloud stores, an optional folder can be specified.

Returns:

Datastore object or None

add_database(name: str, conn_str: str, client_conn_str: str | None = None, conn_type: str = 'shared') → Datastore

Registers a database with the data store.

Parameter	Description
name	Required string. The unique database name on the server.
conn_str	Required string. The path to the folder from the server (and client, if shared or serverOnly database)
client_conn_str	Optional string. The connection string for client to connect to replicated enterprise database>
conn_type	Optional string. The connection type. Default value is shared, other choices are replicated or serverOnly

Returns:

The data item if successfully registered, None otherwise.

add_folder(name: str, server_path: str, client_path: str | None = None) → Datastore

Registers a folder with the data store.

Parameter	Description
name	Required string. The unique fileshare name on the server.
server_path	Required string. The path to the folder from the server (and client, if shared path).
client_path	Optional string. If folder is replicated, the path to the folder from the client; if folder is shared, don’t set this parameter.

Returns:

The data item if successfully registered, None otherwise.

add_object_store(name: str, conn_str: str, object_store: str, provider: str, folder: str | None = None) → Datastore

Object-store data item represents a connection to a Amazon or Microsoft Azure store.

Parameter	Description
name	Required string. The name of the cloud store.
conn_str	Required string. The connection information for the cloud storage product.
object_store	Required string. This is the amazon bucket path or Azuze path.
provider	Required string. Values must be amazon or azure.
folder	Optional string. For some Azure cloud stores, an optional folder can be specified.

Returns:

Datastore object or None

property config: dict

Gets the data store configuration properties. These properties affect the behavior of the data holdings of the server. For example, the blockDataCopy property - when this property is false, or not set at all, copying data to the site when publishing services from a client application is allowed. This is the default behavior. When this property is true, the client application is not allowed to copy data to the site when publishing. Rather, the publisher is required to register data items through which the service being published can reference data. Values: true | false

This operation allows you to update the data store configuration You can use this to allow or block the automatic copying of data to the server at publish time

Parameter	Description
config	Required string. A JSON string containing the data store configuration.

Returns:

JSON dictionary of the set configuration properties.

property data_items: dict

Gets the list of data items that are the root of all other data items in the data store.

federate_data_item(path: str) → bool

This operation can be used to create a data store item in the portal for a data store that has been registered with one of the portal’s federated ArcGIS Server sites.

Once the operation is complete, a data store item is created in the portal with which the ArcGIS Server site is federated. If the data store is registered with only this federated server, no further steps are required. However, if the data store is registered with multiple federated servers and you want any of those servers to access the data store item, you need to bind the data store item with an additional federated server or servers using the PortalDataStore.register method.

Parameter	Description
path	Required string. The item path for the database, cloud, or file share data store for which you want to create a data store item.

Returns:

Boolean

generate_connection_string(sde: str) → str

Converts an SDE connection file to a string with encrypted password.

Parameter	Description
sde	required string. Path to SDE connection file.

Returns:

string on success, None on failure

# Usage

>>> con = dm.generate_connection_string("c:\myfolder\postgres_db.sde")
>>> print(con)
'ENCRYPTED_PASSWORD=************************;SERVER=localhost;
INSTANCE=sde:postgresql:localhost,5432;DBCLIENT=postgresql;
DB_CONNECTION_PROPERTIES=localhost,5432;DATABASE=esri_spatial;
USER=sde;VERSION=sde.DEFAULT;AUTHENTICATION_MODE=DBMS'

get(path: str) → Datastore

Retrieves the data item object at the given path.

Parameter	Description
path	Required string. The path to the data item.

Returns:

The data item object, None if not found.

get_relational_datastore_type(type_id: str) → list

This resource lists the properties of a registered relational data store of the given type. The properties returned are those that client applications must provide when creating a Relational Database Connection portal item.

Note

This method only works if using ArcGIS Insights.

Parameter	Description
type_id	Required string. The datastore type ID of interest. See Relational Data Store Types for details.

Returns:

A JSON string listing the properties

get_total_refcount(path: str) → dict

The total number of references to a given data item that exists on the server. You can use this operation to determine if a data resource can be safely deleted, or taken down for maintenance.

Parameter	Description
path	Required string. The complete hierarchical path to the item.

Returns:

A JSON dictionary containing a number representing the total count.