Upload Service Definition (Server Tools)

Summary

Uploads and shares a web layer, locator, web tool, service, or knowledge graph to ArcGIS Online, ArcGIS Enterprise, or ArcGIS Server.

Usage

This tool uploads and shares a web layer, locator, web tool, service, or knowledge graph based on the input service definition.
This tool does not upload and share service definition draft files (.sddraft). If you have a service definition draft, you can convert it to a staged service definition using the Stage Service tool.
Web tools can only be shared to ArcGIS Enterprise. Geoprocessing services can only be published to ArcGIS Server.
Locators can only be shared to ArcGIS Enterprise. Geocode services can only be published to ArcGIS Server.
Knowledge graphs can only be shared to ArcGIS Enterprise 12.0 or later.
You can specify item IDs when sharing the following to the corresponding ArcGIS Enterprise versions:
- Web feature layer that copies all data—ArcGIS Enterprise 10.8.1 or later
- Web tile layer—ArcGIS Enterprise 10.8.1 or later
- Map image layer—ArcGIS Enterprise 11.2 or later
- Web feature layer that references registered data—ArcGIS Enterprise 11.2 or later
- OGC feature layer—ArcGIS Enterprise 11.2 or later
- WMS service layer—ArcGIS Enterprise 11.2 or later
- WFS service layer—ArcGIS Enterprise 11.2 or later
- Knowledge graphs—ArcGIS Enterprise 12.0 or later

Label	Explanation	Data type
Service Definition	The service definition file (`.sd`) that contains all the information needed to share a web layer, locator, web tool, service, or knowledge graph.	File
Server	The server type. The following server types are supported: My Hosted Services—Use when sharing a hosted web layer to ArcGIS Online or ArcGIS Enterprise. Enter My Hosted Services for the server connection. Capitalize the first letter of each word and include a space between each word. HOSTING_SERVER—Use when sharing a hosted web layer to ArcGIS Online or ArcGIS Enterprise. URL to the ArcGIS Enterprise portal federated server—Use when sharing a web tool or map image layer to an ArcGIS Enterprise portal federated server. ArcGIS Server connection—Use when sharing a map or geoprocessing service to ArcGIS Server. You can use ArcGIS Server connections listed under the Servers node in the Project window, or you can browse to a folder where server connection files are stored. URL to ArcGIS Server—Use when sharing a map or geoprocessing service to ArcGIS Server. You can specify the URL to ArcGIS Server provided a publisher connection to ArcGIS Server has been added to the ArcGIS Pro project, and you're opening the project in the script or you're running the tool in ArcGIS Pro. KNOWLEDGE_SERVER—Use when sharing a knowledge graph to ArcGIS Enterprise 12.0 or later.	ServerConnection
Service Name (Optional)	The service name that will override the current service name specified in the service definition.	String
Cluster (Optional)	The cluster name that will override the current cluster to which the service has been assigned. You must choose from clusters on the specified server. Legacy: Clusters are deprecated at ArcGIS Enterprise 10.5.1. This parameter will be ignored for servers that do not support multiple clusters.	String
Folder Type (Optional)	Specifies the folder type that will be used to determine the source for the folder. The default is a folder from the service definition. You can also get a list of existing folders on the specified online server, or you can specify that a new folder be created once you share the web layer, service, or knowledge graph. New—A new folder will be created. Existing—An existing folder on the server will be used. From Service Definition—The folder in the service definition will be used. This is the default.	String
Folder (Optional)	The folder that will be used for the web layer, service, or knowledge graph. If no folder is provided, the folder specified in the service definition will be used. If you specified New for Folder Type, use this parameter to provide a folder name. If you specified Existing for Folder Type, you can choose from the existing folders on the server.	String
Start service immediately (Optional)	Specifies whether the service will be started after sharing. Checked—The service will be started after sharing. This is the default. Unchecked—The service will not be started after sharing.	Boolean
Override service definition sharing properties (Optional)	Specifies whether the sharing properties set in the service definition will be overridden. These properties define if, and how, you are sharing the web layer, web tool, or knowledge graph with ArcGIS Online or ArcGIS Enterprise. You must be signed in to ArcGIS Online or ArcGIS Enterprise to override sharing properties. This parameter is not honored when sharing to ArcGIS Server. Checked—The sharing properties set in the service definition will be overridden. Unchecked—The sharing properties set in the service definition will not be overridden; they will be used. This is the default.	Boolean
Share on ArcGIS Online (Optional)	Specifies whether the web layer, web tool, or knowledge graph will be shared. All shared web layers, web tools, or knowledge graphs are available through My Content. Even if you only want to share with a specific group in your organization, the web layer, web tool, or knowledge graph will also be shared through My Content. You must be signed in to a portal to override sharing properties. This parameter is not honored when sharing to ArcGIS Server. Checked—Your content will be shared on ArcGIS Online or ArcGIS Enterprise. The web layer, web tool, or knowledge graph will be listed under My Content. Unchecked—Your content will not be shared on ArcGIS Online or ArcGIS Enterprise and will be inaccessible to other ArcGIS Online or ArcGIS Enterprise users and clients on the web. This is the default.	Boolean
Share With Everyone (Public) (Optional)	Specifies whether the web layer or web tool will be available to the public. You must be signed in to ArcGIS Online or ArcGIS Enterprise to override sharing properties. This parameter is not honored when sharing to ArcGIS Server. This parameter is not supported when sharing a knowledge graph. Checked—Your content will be available to the public. Unchecked—Your content will not be available to the public. This is the default.	Boolean
Share With Your Organization (Optional)	Specifies whether the web layer, web tool, or knowledge graph will be shared with your organization. You must be signed in to ArcGIS Online or ArcGIS Enterprise to override sharing properties. This parameter is not honored when sharing to ArcGIS Server. Checked—Your content will be shared with your organization. Unchecked—Your content will not be shared with your organization. This is the default.	Boolean
Share With These Groups (Optional)	Specifies whether the web layer, web tool, or knowledge graph will be shared with specified groups in your organization. Checked—Your content will be shared with specified groups. Unchecked—Your content will not be shared with specified groups. You must be signed in to ArcGIS Online or ArcGIS Enterprise to override sharing properties. This parameter is not honored when sharing to ArcGIS Server.	String
Output Item IDs (Optional)	Specifies the item IDs of the output web layers or knowledge graph staged in the input service definition. An item ID can be specified for each item. The ID must be available and contain 32 alphanumeric values ranging from the letters a to f and numbers 0 to 9. If no ID is provided, an item ID will be automatically created. Item IDs can be specified for the following: Web feature layer—ArcGIS Enterprise 10.8.1 or later Web tile layer—ArcGIS Enterprise 10.8.1 or later Map image layer—ArcGIS Enterprise 11.2 or later OGC feature layer—ArcGIS Enterprise 11.2 or later WMS—ArcGIS Enterprise 11.2 or later WFS—ArcGIS Enterprise 11.2 or later Knowledge graph—ArcGIS Enterprise 12.0 or later This parameter is not available if the service definition is set to overwrite an existing service or if an ArcGIS Server connection or URL to ArcGIS Server is provided. Value table columns: Item Type—The item type. Item ID—The item IDs of the output web layers staged in the input service definition.	Value Table

Derived output

Label	Explanation	Data type
SOAP Service URL	The SOAP URL of a service published to the server.	String
REST Service URL	The REST URL of a service published to the server.	String
Hosted Map Service Item ID	The Item ID of the map image layer shared to the portal.	String
Hosted Feature Service Item ID	The Item ID of the hosted feature service layer shared to the portal.	String
Cached Service	An image service or a map service with caching enabled.	Image Service; Map Server
Feature Service URL	The REST URL of a hosted feature layer shared to the portal.	String
Map Service URL	The REST URL of a map image layer shared to the portal.	String
Layer ID	The published layers and their respective IDs in the format Layer1\|ID1;Layer2\|ID2; and so on.	String
Service URL	The published stand-alone tables and their respective IDs in the format Table1\|ID1;Table2\|ID2; and so on.	String
Hosted Vector Tile Service Item ID	The Item ID of the vector tile service.	String
Vector Tile Service URL	The REST URL of the vector tile service.	String
Item ID	The Item IDs of the web items shared to the portal. An Item ID will include one of the following strings: `web_feature_layer_id` `web_tile_layer_id` `map_image_layer_id` `ogc_feature_layer_id` `wms_id` `wfs_id` `knowledge_graph_id`	Value Table

arcpy.server.UploadServiceDefinition(in_sd_file, in_server, {in_service_name}, {in_cluster}, {in_folder_type}, {in_folder}, {in_startupType}, {in_override}, {in_my_contents}, {in_public}, {in_organization}, {in_groups}, {in_item_id})

Name	Explanation	Data type
in_sd_file	The service definition file (`.sd`) that contains all the information needed to share a web layer, locator, web tool, service, or knowledge graph.	File
in_server	The server type. The following server types are supported: My Hosted Services—Use when sharing a hosted web layer to ArcGIS Online or ArcGIS Enterprise. Enter My Hosted Services for the server connection. Capitalize the first letter of each word and include a space between each word. HOSTING_SERVER—Use when sharing a hosted web layer to ArcGIS Online or ArcGIS Enterprise. URL to the ArcGIS Enterprise portal federated server—Use when sharing a web tool or map image layer to an ArcGIS Enterprise portal federated server. ArcGIS Server connection—Use when sharing a map or geoprocessing service to ArcGIS Server. You can use ArcGIS Server connections listed under the Servers node in the Project window, or you can browse to a folder where server connection files are stored. URL to ArcGIS Server—Use when sharing a map or geoprocessing service to ArcGIS Server. You can specify the URL to ArcGIS Server provided a publisher connection to ArcGIS Server has been added to the ArcGIS Pro project, and you're opening the project in the script or you're running the tool in ArcGIS Pro. KNOWLEDGE_SERVER—Use when sharing a knowledge graph to ArcGIS Enterprise 12.0 or later.	ServerConnection
in_service_name (Optional)	The service name that will override the current service name specified in the service definition.	String
in_cluster (Optional)	The cluster name that will override the current cluster to which the service has been assigned. You must choose from clusters on the specified server. Legacy: Clusters are deprecated at ArcGIS Enterprise 10.5.1. This parameter will be ignored for servers that do not support multiple clusters.	String
in_folder_type (Optional)	Specifies the folder type that will be used to determine the source for the folder. The default is a folder from the service definition. You can also get a list of existing folders on the specified online server, or you can specify that a new folder be created once you share the web layer, service, or knowledge graph. `NEW`—A new folder will be created. `EXISTING`—An existing folder on the server will be used. `FROM_SERVICE_DEFINITION`—The folder in the service definition will be used. This is the default.	String
in_folder (Optional)	The folder that will be used for the web layer, service, or knowledge graph. If no folder is provided, the folder specified in the service definition will be used. If you specified `NEW` for `in_folder_type`, use this parameter to provide a folder name. If you specified `EXISTING` for `in_folder_type`, you can choose from the existing folders on the server.	String
in_startupType (Optional)	Specifies whether the service will be started after sharing. `STARTED`—The service will be started after sharing. This is the default. `STOPPED`—The service will not be started after sharing.	Boolean
in_override (Optional)	Specifies whether the sharing properties set in the service definition will be overridden. These properties define if, and how, you are sharing the web layer, web tool, or knowledge graph with ArcGIS Online or ArcGIS Enterprise. You must be signed in to ArcGIS Online or ArcGIS Enterprise to override sharing properties. This parameter is not honored when sharing to ArcGIS Server. `OVERRIDE_DEFINITION`—The sharing properties set in the service definition will be overridden. `USE_DEFINITION`—The sharing properties set in the service definition will not be overridden; they will be used. This is the default.	Boolean
in_my_contents (Optional)	Specifies whether the web layer, web tool, or knowledge graph will be shared. All shared web layers, web tools, or knowledge graphs are available through My Content. Even if you only want to share with a specific group in your organization, the web layer, web tool, or knowledge graph will also be shared through My Content. You must be signed in to a portal to override sharing properties. This parameter is not honored when sharing to ArcGIS Server. `SHARE_ONLINE`—Your content will be shared on ArcGIS Online or ArcGIS Enterprise. The web layer, web tool, or knowledge graph will be listed under My Content. `NO_SHARE_ONLINE`—Your content will not be shared on ArcGIS Online or ArcGIS Enterprise and will be inaccessible to other ArcGIS Online or ArcGIS Enterprise users and clients on the web. This is the default.	Boolean
in_public (Optional)	Specifies whether the web layer or web tool will be available to the public. You must be signed in to ArcGIS Online or ArcGIS Enterprise to override sharing properties. This parameter is not honored when sharing to ArcGIS Server. This parameter is not supported when sharing a knowledge graph. `PUBLIC`—Your content will be available to the public. `PRIVATE`—Your content will not be available to the public. This is the default.	Boolean
in_organization (Optional)	Specifies whether the web layer, web tool, or knowledge graph will be shared with your organization. You must be signed in to ArcGIS Online or ArcGIS Enterprise to override sharing properties. This parameter is not honored when sharing to ArcGIS Server. `SHARE_ORGANIZATION`—Your content will be shared with your organization. `NO_SHARE_ORGANIZATION`—Your content will not be shared with your organization. This is the default.	Boolean
in_groups [in_groups,...] (Optional)	A list of group names with which the web layer, web tool, or knowledge graph will be shared. You must be signed in to ArcGIS Online or ArcGIS Enterprise to override sharing properties. This parameter is not honored when sharing to ArcGIS Server.	String
in_item_id [in_item_id,...] (Optional)	Specifies the item IDs of the output web layers or knowledge graph staged in the input service definition. An item ID can be specified for each item. The ID must be available and contain 32 alphanumeric values ranging from the letters a to f and numbers 0 to 9. If no ID is provided, an item ID will be automatically created. Item IDs can be specified for the following: `web_feature_layer_id`—ArcGIS Enterprise 10.8.1 or later `web_tile_layer_id`—ArcGIS Enterprise 10.8.1 or later `map_image_layer_id`—ArcGIS Enterprise 11.2 or later `ogc_feature_layer_id`—ArcGIS Enterprise 11.2 or later `wms_id`—ArcGIS Enterprise 11.2 or later `wfs_id`—ArcGIS Enterprise 11.2 or later `knowledge_graph_id`—ArcGIS Enterprise 12.0 or later This parameter is not available if the service definition is set to overwrite an existing service or if an ArcGIS Server connection or URL to ArcGIS Server is provided. Value table columns: `Item Type`—The item type. `Item ID`—The item IDs of the output web layers staged in the input service definition.	Value Table

Derived output

Name	Explanation	Data type
out_soap_svc_url	The SOAP URL of a service published to the server.	String
out_rest_svc_url	The REST URL of a service published to the server.	String
out_mapServiceItemID	The Item ID of the map image layer shared to the portal.	String
out_featServiceItemID	The Item ID of the hosted feature service layer shared to the portal.	String
out_cached_service	An image service or a map service with caching enabled.	Image Service; Map Server
out_featureServiceURL	The REST URL of a hosted feature layer shared to the portal.	String
out_mapServiceURL	The REST URL of a map image layer shared to the portal.	String
out_LayerIDMap	The published layers and their respective IDs in the format Layer1\|ID1;Layer2\|ID2; and so on.	String
out_standaloneTableIDMap	The published stand-alone tables and their respective IDs in the format Table1\|ID1;Table2\|ID2; and so on.	String
out_vectorTileServiceID	The Item ID of the vector tile service.	String
out_vectorTileServiceURL	The REST URL of the vector tile service.	String
out_item_id	The Item IDs of the web items shared to the portal. An Item ID will include one of the following strings: `web_feature_layer_id` `web_tile_layer_id` `map_image_layer_id` `ogc_feature_layer_id` `wms_id` `wfs_id` `knowledge_graph_id`	Value Table

Code sample

UploadServiceDefinition example 1 (stand-alone script)

The following script publishes a list of layers from a map as a web tile layer to either ArcGIS Enterprise or ArcGIS Online. Portal information is obtained from the SignInToPortal function.

import arcpy
import os

# Sign in to portal
arcpy.SignInToPortal("https://www.arcgis.com", "MyUserName", "MyPassword")

# Set output file names
outdir = r"C:\Project\Output"
service = "TileSharingDraftExample"
sddraft_filename = service + ".sddraft"
sddraft_output_filename = os.path.join(outdir, sddraft_filename)

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps("World")[0]
lyrs = []
lyrs.append(m.listLayers('Cities')[0])
lyrs.append(m.listLayers('Counties')[0])

# Create TileSharingDraft and set service properties
sharing_draft = m.getWebLayerSharingDraft("HOSTING_SERVER", "TILE", service, lyrs)
sharing_draft.summary = "My Summary"
sharing_draft.tags = "My Tags"
sharing_draft.description = "My Description"
sharing_draft.credits = "My Credits"
sharing_draft.useLimitations = "My Use Limitations"

# Create Service Definition Draft file
sharing_draft.exportToSDDraft(sddraft_output_filename)

# Stage Service
sd_filename = service + ".sd"
sd_output_filename = os.path.join(outdir, sd_filename)
arcpy.server.StageService(sddraft_output_filename, sd_output_filename)

# Share to portal
print("Start Uploading")
result = arcpy.server.UploadServiceDefinition(sd_output_filename, "My Hosted Services")

value_table_op = arcpy.ValueTable(2)
value_table_op.loadFromString(result[11])
for i in range(0, value_table_op.rowCount):
   print(value_table_op.getRow(i))

print("Finish Publishing")

UploadServiceDefinition example 2 (stand-alone script)

The following script uploads an existing service definition and uses optional parameters to modify properties of the service.

import arcpy

# Set local variables
inSdFile = r"C:\Project\MapServiceDraftExample.sd"
inServer = r"C:\Project\gisserver.ags.esri.com.ags"
inServiceName = "newServiceName"
inFolderType = "NEW"
inFolder = "newFolder"
inStartup = "STOPPED"

# Run UploadServiceDefinition
arcpy.server.UploadServiceDefinition(inSdFile, inServer, inServiceName,
                                     in_folder_type=inFolderType, in_folder=inFolder,
                                     in_startupType=inStartup)

UploadServiceDefinition example 3 (stand-alone script)

The following script uploads an existing service definition to either ArcGIS Online or ArcGIS Enterprise and uses optional parameters to modify properties of the service. The optional in_item_id parameter is used to specify an item ID for the web layer when sharing to ArcGIS Enterprise.

import arcpy

# Sign in to portal
arcpy.SignInToPortal("https://organization.example.com/webadaptorname",
                     "MyUserName", "MyPassword")

# Set local variables
inSdFile = r"C:\Project\MapImageLayer_WFS_WMSExample.sd"
inServer = "https://gisserver.example.com/webadaptor"
inServiceName = "newServiceName"
inFolderType = "EXISTING"
inFolder = "existingFolder"
inOverride = "OVERRIDE_DEFINITION"
inMyContents = "SHARE_ONLINE"
inPublic = "PRIVATE"
inOrganization = "NO_SHARE_ORGANIZATION"
inGroups = ["My Group", "MyGroup 2"]

# Replace "itemid1" and "itemid2" with desired item IDs
item_id = "wfs_id itemid1; wms_id itemid2"

# Run UploadServiceDefinition
arcpy.server.UploadServiceDefinition(inSdFile, inServer, inServiceName,
                                     in_folder_type=inFolderType,
                                     in_folder=inFolder,
                                     in_override=inOverride,
                                     in_my_contents=inMyContents,
                                     in_public=inPublic,
                                     in_organization=inOrganization,
                                     in_groups=inGroups,
                                     in_item_id=item_id)

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: Yes
Standard: Yes
Advanced: Yes

Upload Service Definition (Server Tools)

Summary

Usage

Parameters

Legacy:

Derived output

Environments

Licensing information

Related topics